From fefc3436db461c827e742091a7d9f6bd990fe8ec Mon Sep 17 00:00:00 2001 From: gardener-robot-ci-2 Date: Mon, 5 Aug 2024 05:54:48 +0000 Subject: [PATCH] update documentation --- _static/searchtools.js | 7 ++++--- searchindex.js | 2 +- traits/draft_release.html | 2 +- traits/release.html | 2 +- 4 files changed, 7 insertions(+), 6 deletions(-) diff --git a/_static/searchtools.js b/_static/searchtools.js index 92da3f8b2..b08d58c9b 100644 --- a/_static/searchtools.js +++ b/_static/searchtools.js @@ -178,7 +178,7 @@ const Search = { htmlToText: (htmlString, anchor) => { const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); - for (const removalQuery of [".headerlinks", "script", "style"]) { + for (const removalQuery of [".headerlink", "script", "style"]) { htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); } if (anchor) { @@ -328,13 +328,14 @@ const Search = { for (const [title, foundTitles] of Object.entries(allTitles)) { if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { for (const [file, id] of foundTitles) { - let score = Math.round(100 * queryLower.length / title.length) + const score = Math.round(Scorer.title * queryLower.length / title.length); + const boost = titles[file] === title ? 1 : 0; // add a boost for document titles normalResults.push([ docNames[file], titles[file] !== title ? `${titles[file]} > ${title}` : title, id !== null ? "#" + id : "", null, - score, + score + boost, filenames[file], ]); } diff --git a/searchindex.js b/searchindex.js index e523689c3..0f6455d80 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"(GitHub) Repositories": [[2, "github-repositories"]], "Additional Repositories": [[2, "additional-repositories"]], "Attributes": [[1, "attributes"], [1, "id1"], [2, "attributes"], [2, "repository-config"], [3, "pipeline-step"], [6, "trait-component-descriptor"], [7, "trait-cronjob"], [8, "trait-draft-release"], [9, "trait-image-scan"], [10, "trait-notifications"], [11, "trait-options"], [12, "trait-publish"], [13, "trait-pullrequest"], [14, "trait-release"], [15, "trait-scan-sources"], [16, "trait-scheduling"], [17, "trait-slack"], [18, "trait-update-component-deps"], [19, "trait-version"]], "Behavioural Contract": [[18, "behavioural-contract"]], "Branch-specific configuration": [[1, "branch-specific-configuration"]], "CC-Utils - Build Pipeline Reference Manual": [[0, "cc-utils-build-pipeline-reference-manual"]], "Category - Title Mapping": [[4, "category-title-mapping"]], "Cleanup Semantics and Use-Case": [[6, "cleanup-semantics-and-use-case"]], "Commits": [[4, "commits"]], "Component Upgrade Contract": [[18, "component-upgrade-contract"]], "Contract": [[14, "contract"], [14, "id1"]], "Declaring Additional Dependencies": [[6, "declaring-additional-dependencies"]], "Default Component Descriptor": [[6, "default-component-descriptor"]], "Default behaviour for trigger attribute": [[2, "default-behaviour-for-trigger-attribute"]], "Dependencies": [[6, "trait-component-descriptor"], [7, "trait-cronjob"], [8, "trait-draft-release"], [9, "trait-image-scan"], [10, "trait-notifications"], [11, "trait-options"], [12, "trait-publish"], [13, "trait-pullrequest"], [14, "trait-release"], [15, "trait-scan-sources"], [16, "trait-scheduling"], [17, "trait-slack"], [18, "trait-update-component-deps"], [19, "trait-version"]], "Draft Release": [[4, "draft-release"]], "Environment Variables": [[2, "environment-variables"]], "Environment Variables Passed to component_descriptor": [[6, "environment-variables-passed-to-component-descriptor"]], "Environment Variables from repositories": [[2, "environment-variables-from-repositories"]], "Example": [[2, "example"], [6, "example"], [6, "id1"], [7, "example"], [10, "example"], [12, "example"], [13, "example"], [14, "example"], [14, "id2"], [16, "example"], [17, "example"]], "Example (hotfix-branch release jobs)": [[1, "example-hotfix-branch-release-jobs"]], "Example (schematic)": [[1, "example-schematic"]], "Example - Inheritance / \u201cbase_definition\u201d": [[1, "example-inheritance-base-definition"]], "Example .ci/pipeline_definitions": [[1, "example-ci-pipeline-definitions"]], "Examples": [[2, "examples"], [3, "examples"]], "Extension Note": [[18, "extension-note"]], "Format": [[4, "format"]], "How to Contribute to Release Notes": [[4, "how-to-contribute-to-release-notes"]], "Indices and Tables": [[5, "indices-and-tables"]], "Indices and tables": [[0, "indices-and-tables"]], "Introduction": [[0, "introduction"]], "Local Development and \u201ccomponent-cli\u201d": [[6, "local-development-and-component-cli"]], "Main Repository": [[2, "main-repository"]], "Optional Dev Cycle Callback": [[14, "optional-dev-cycle-callback"]], "Optional Release Callback": [[14, "optional-release-callback"]], "Passed Environment Variables": [[18, "passed-environment-variables"]], "Path filtering semantics": [[15, "path-filtering-semantics"]], "Pipeline Definition": [[1, "pipeline-definition"]], "Pipeline Definition Schema": [[1, "pipeline-definition-schema"]], "Pipeline Definition Traits": [[5, "pipeline-definition-traits"]], "Pipeline Job": [[2, "pipeline-job"]], "Pipeline Steps": [[3, "pipeline-steps"]], "Policies / Pull-Request Label Handling": [[13, "policies-pull-request-label-handling"]], "Posting Release Notes To Slack": [[4, "posting-release-notes-to-slack"]], "Pull Requests": [[4, "pull-requests"]], "Release Notes Process": [[4, "release-notes-process"]], "Rendering Component-Descriptor": [[6, "rendering-component-descriptor"]], "Repository Attributes": [[2, "repository-attributes"]], "Retention Policies (aka cleaning up old versions)": [[6, "retention-policies-aka-cleaning-up-old-versions"]], "Setting up Preliminaries": [[6, "setting-up-preliminaries"]], "Special-handling for \u201ccharts/images.yaml\u201d / deprecating component-cli": [[6, "special-handling-for-charts-images-yaml-deprecating-component-cli"]], "Supported labels": [[15, "supported-labels"]], "Terms, Definitions and Concepts": [[0, "terms-definitions-and-concepts"]], "Transporting Release Notes": [[4, "transporting-release-notes"]], "cfg_names attribute": [[2, "cfg-names-attribute"]], "checkmarx": [[15, "checkmarx"]], "checkmarx (CheckmarxCfg) Attributes": [[15, "trait-scan-sources"]], "clam_av (ClamAVScanCfg) Attributes": [[9, "trait-image-scan"]], "component_descriptor Trait": [[6, "component-descriptor-trait"]], "cronjob Trait": [[7, "cronjob-trait"]], "default (NotificationCfgSet) Attributes": [[10, "trait-notifications"]], "default.on_error (NotificationCfg) Attributes": [[10, "trait-notifications"]], "default.on_error.recipients Enumeration Values": [[10, "trait-notifications"]], "default.on_error.triggering_policy Enumeration Values": [[10, "trait-notifications"]], "dockerimages. (PublishDockerImageDescriptor) Attributes": [[12, "trait-publish"]], "draft_release Trait": [[8, "draft-release-trait"]], "filters (FilterCfg) Attributes": [[15, "trait-scan-sources"]], "image_scan Trait": [[9, "image-scan-trait"]], "implicitly injected build steps": [[12, "implicitly-injected-build-steps"]], "inputs Attribute": [[12, "inputs-attribute"]], "merge_policy Enumeration Values": [[18, "trait-update-component-deps"]], "nextversion Enumeration Values": [[14, "trait-release"]], "notifications Trait": [[10, "notifications-trait"]], "notify Enumeration Values": [[9, "trait-image-scan"], [15, "trait-scan-sources"]], "oci-builder Enumeration Values": [[12, "trait-publish"]], "on_tag_conflict Enumeration Values": [[14, "trait-release"]], "options Trait": [[11, "options-trait"]], "os_id (OsIdScan) Attributes": [[9, "trait-image-scan"]], "policies (PullRequestPolicies) Attributes": [[13, "trait-pullrequest"]], "preferred_protocol Enumeration Values": [[2, "repository-config"]], "preprocess Attribute": [[19, "preprocess-attribute"]], "privilege_mode Enumeration Values": [[3, "pipeline-step"]], "protecode": [[15, "protecode"]], "publish Trait": [[12, "publish-trait"]], "pull-request Trait": [[13, "pull-request-trait"]], "release Trait": [[14, "release-trait"]], "release_callback_image_reference (OciImageCfg) Attributes": [[14, "trait-release"]], "release_commit_publishing_policy Enumeration Values": [[14, "trait-release"]], "release_notes_policy Enumeration Values": [[14, "trait-release"]], "scan_sources Trait": [[15, "scan-sources-trait"]], "scheduling Trait": [[16, "scheduling-trait"]], "set_dependency_version_script_container_image (OciImageCfg) Attributes": [[18, "trait-update-component-deps"]], "slack Trait": [[17, "slack-trait"]], "trigger_paths attribute": [[2, "trigger-paths-attribute"]], "update_component_deps Trait": [[18, "update-component-deps-trait"]], "upload Enumeration Values": [[6, "trait-component-descriptor"]], "version Trait": [[19, "version-trait"]], "version_interface Enumeration Values": [[19, "trait-version"]], "\u201cimagevector add\u201d command / charts/images.yaml contract": [[6, "imagevector-add-command-charts-images-yaml-contract"]]}, "docnames": ["index", "pipeline", "pipeline_job", "pipeline_step", "release_notes", "traits", "traits/component_descriptor", "traits/cronjob", "traits/draft_release", "traits/image_scan", "traits/notifications", "traits/options", "traits/publish", "traits/pullrequest", "traits/release", "traits/scan_sources", "traits/scheduling", "traits/slack", "traits/update_component_deps", "traits/version"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "pipeline.rst", "pipeline_job.rst", "pipeline_step.rst", "release_notes.rst", "traits.rst", "traits/component_descriptor.rst", "traits/cronjob.rst", "traits/draft_release.rst", "traits/image_scan.rst", "traits/notifications.rst", "traits/options.rst", "traits/publish.rst", "traits/pullrequest.rst", "traits/release.rst", "traits/scan_sources.rst", "traits/scheduling.rst", "traits/slack.rst", "traits/update_component_deps.rst", "traits/version.rst"], "indexentries": {"component_descriptor": [[6, "trait-component-descriptor", false]], "cronjob": [[7, "trait-cronjob", false]], "draft_release": [[8, "trait-draft-release", false]], "image_scan": [[9, "trait-image-scan", false]], "modelelement": [[2, "repository-config", false], [3, "pipeline-step", false]], "notifications": [[10, "trait-notifications", false]], "options": [[11, "trait-options", false]], "pipeline step": [[3, "pipeline-step", false]], "publish": [[12, "trait-publish", false]], "pullrequest": [[13, "trait-pullrequest", false]], "release": [[14, "trait-release", false]], "repository config": [[2, "repository-config", false]], "scan_sources": [[15, "trait-scan-sources", false]], "scheduling": [[16, "trait-scheduling", false]], "slack": [[17, "trait-slack", false]], "trait": [[6, "trait-component-descriptor", false], [7, "trait-cronjob", false], [8, "trait-draft-release", false], [9, "trait-image-scan", false], [10, "trait-notifications", false], [11, "trait-options", false], [12, "trait-publish", false], [13, "trait-pullrequest", false], [14, "trait-release", false], [15, "trait-scan-sources", false], [16, "trait-scheduling", false], [17, "trait-slack", false], [18, "trait-update-component-deps", false], [19, "trait-version", false]], "update_component_deps": [[18, "trait-update-component-deps", false]], "version": [[19, "trait-version", false]]}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [1, 2, 3, 6, 7, 9, 12, 14, 15, 18, 19], "0": [4, 6, 9, 15, 18], "00": 7, "04": 6, "06": 6, "08": 7, "09": 7, "1": [4, 6, 18], "10": 6, "100": 6, "1000": 11, "120": [9, 15], "128": 6, "13": 7, "147": 4, "18": [4, 7], "18h": 9, "1h30m": [3, 9], "2": [6, 18], "20": 1, "2023": 6, "2h": 9, "3": [3, 6, 18], "30": [7, 9, 15], "3600": 15, "386": 12, "4": 6, "42": 7, "42m": 7, "45": 7, "5": 6, "5m": 7, "6": [3, 6], "64": 6, "67": 6, "8": 9, "90": [9, 15], "A": [1, 3, 4, 6, 7], "As": [0, 4, 12], "By": [1, 3, 12, 18], "For": [1, 2, 6, 13, 18], "If": [1, 2, 3, 4, 6, 7, 9, 12, 14, 15, 17], "In": [0, 2, 4, 6, 9, 18], "It": [2, 3, 4, 6, 12, 18], "No": 14, "On": 4, "One": [6, 15, 17], "Such": 14, "The": [1, 2, 3, 4, 6, 7, 9, 12, 14, 15, 18], "There": [4, 6], "To": [6, 12, 13], "_": 2, "_after_": 12, "_all_": 12, "_branch": 2, "_default_": 6, "_github_repo_owner_and_nam": 2, "_may_": 12, "_path": [2, 3, 12], "_permanent_": 6, "abc": 18, "abort": [3, 9], "about": [9, 13, 15], "abov": [2, 4, 6, 18], "absent": [6, 15], "absolut": [6, 10, 12, 14, 18], "abstract": 0, "acccord": 6, "accept": [3, 9, 19], "access": [3, 4, 6, 9, 11, 12], "accur": 6, "achiev": 4, "action": [4, 14, 15], "actual": 3, "ad": [4, 6, 13, 14], "add": [0, 2, 3, 4, 12, 14, 19], "add_depend": 6, "add_dependencies_cmd": 6, "addit": [3, 12, 14], "address": 10, "adher": 1, "affect": [2, 7], "after": [3, 6, 9, 13, 14, 18], "after_merge_callback": 18, "ag": 9, "again": [4, 12, 13], "against": 14, "aka": 12, "all": [0, 1, 2, 3, 4, 6, 9, 12, 15, 18], "allow": [2, 3, 12], "along": [6, 18], "alphanumer": [1, 2], "alpin": [3, 6], "alreadi": [1, 4, 14], "also": [3, 6, 12, 18], "although": 0, "altogeth": 4, "alwai": [2, 10, 12], "amd64": 12, "among": 6, "amount": [1, 2, 3, 6, 9, 11, 12], "an": [0, 1, 2, 3, 4, 6, 10, 12, 14, 18, 19], "an_env_var": 3, "ani": [1, 2, 3, 6, 14, 18], "anoth": [1, 3, 6], "another_execut": 3, "another_ocm_repo_url": 6, "another_pipelin": 1, "another_repo": 3, "another_step": 1, "anotherdockerfil": 12, "anymor": 4, "api": 4, "appear": 4, "appli": [1, 13, 15, 18], "ar": [0, 1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 13, 14, 17, 18, 19], "arbitrari": [1, 2, 3, 12], "arch": [6, 12], "architectur": 12, "arg": [3, 6], "argument": [3, 12, 18], "argv": 3, "arithmet": 6, "arm": 12, "arm64": 12, "around": 0, "artefact": 6, "articl": 4, "artifact": [6, 15], "ascii": [1, 2], "asset": [6, 14], "assign": 3, "assum": [6, 18], "attr": [3, 9, 15], "auth": 2, "authent": [2, 3], "auto": 18, "auto_merg": 18, "autom": [0, 6], "automat": [4, 6, 8, 18, 19], "avail": [2, 3, 6, 9, 10, 12, 14, 15, 18, 19], "avoid": [14, 18], "aw": 9, "aws_cfg_nam": 9, "back": 14, "backup": 6, "backward": [6, 14], "bar": [2, 10], "base": [2, 4, 6, 12], "base_definition_path": 6, "base_url": 6, "basi": 4, "bazz": 10, "been": [2, 6], "befor": [6, 9, 11, 14], "begin": [7, 13], "behaviour": [6, 7, 12, 14], "being": [1, 6, 9, 13], "below": [1, 2, 4, 6, 10], "berlin": 7, "between": [3, 7], "bewar": 3, "bill": 6, "binary_path": 12, "blob": 6, "block": 4, "blocker": [9, 15], "blow": 10, "bodi": [9, 15], "bool": [2, 3, 6, 10, 11, 12, 14, 15, 16, 18, 19], "both": [6, 12], "bound": 4, "branch": [2, 6, 14, 19], "break": 4, "bugfix": 4, "build": [1, 2, 3, 4, 6, 7, 9, 10, 11, 13, 14, 19], "build_and_expose_output": 3, "build_arg": 12, "build_dir": 12, "build_logs_to_retain": 11, "build_result": 12, "build_result_dir": 3, "build_result_path": 12, "buildkit": 12, "buildstepfileasset": 14, "buildsteplogasset": 14, "buildx": 12, "built": [6, 12], "bump": 14, "bump_major": 14, "bump_minor": [1, 4, 14], "bump_patch": [1, 14], "buzz": 10, "c": 6, "cach": 3, "cache_path": 3, "calcul": [3, 14, 19], "call": [6, 10, 14, 18], "callback": [6, 10, 12, 18, 19], "callback_env": 6, "can": [4, 6, 12, 14, 19], "cannot": [3, 4], "care": 6, "carefulli": 3, "case": [2, 3, 4, 9, 10, 12, 14, 18], "caution": 3, "cautiou": 4, "cc": [2, 6, 9, 17, 18], "cd": 0, "central": 0, "certain": [0, 2, 9], "cfg": [1, 6, 9, 10], "cfg_callback": 10, "cfg_name": [1, 3, 15], "chang": [0, 2, 3, 4, 7, 12, 13, 14, 18, 19], "channel": [4, 17], "channel_cfg": [4, 17], "channel_nam": [4, 17], "channelconfig": 17, "char": 1, "charact": [2, 3], "charat": 1, "chdir": 6, "check": 18, "chosen": [1, 2, 14], "ci": [0, 2, 3, 6, 18], "cicd": [6, 12], "clamav": 9, "clamav_cfg_nam": 9, "clamavrescoringentri": 9, "clean": 18, "close": 6, "cloud": [6, 15], "cmd": 6, "cnudi": 15, "code": [3, 4, 6, 14, 18], "codeown": 10, "collect": [6, 8], "com": [2, 4, 6, 10, 18], "commit": [2, 3, 10, 14, 19], "commit_message_prefix": 14, "committ": 10, "common": [1, 12], "commun": 4, "compar": [9, 18], "compat": [6, 14, 19], "compil": 6, "complianc": 15, "compon": [0, 1, 2, 3, 4, 9, 10, 12, 14, 15, 19], "component_descriptor": [5, 8, 9, 14, 15, 18], "component_descriptor_dir": 10, "component_descriptor_path": 6, "component_diff_own": 10, "component_label": 6, "component_nam": [6, 9, 15], "component_own": [9, 15], "component_vers": [6, 9, 15], "concours": [0, 1, 2, 4, 14], "config": [2, 4, 9, 12, 15, 17], "configur": [2, 3, 4, 6, 7, 9, 10, 12, 13, 14, 15, 17, 18], "conflict": 14, "conjunct": 12, "consid": [1, 4, 6, 14, 15], "construct": 2, "consum": 12, "consumpt": 12, "contain": [0, 1, 3, 4, 6, 9, 12, 13, 14, 15, 18], "container_imag": 18, "content": [9, 12], "context": [0, 6], "continu": 0, "contract": 0, "contribut": 0, "conveni": 6, "convent": [6, 18], "convert": [2, 3, 6], "copi": 12, "correspond": [2, 4, 13], "count": 3, "cp": [6, 12], "creat": [3, 4, 6, 8, 12, 14, 15, 18], "creation": [13, 14, 18], "critic": [9, 15], "cronjob": [2, 5], "cross": 12, "ctx": 6, "ctx_repositori": 6, "ctx_repository_base_url": 6, "cumbersom": 6, "current": [1, 3, 6, 9, 18, 19], "custom": [9, 14, 15], "custom_execut": 3, "custom_imag": 3, "customis": [0, 6, 10], "dai": [7, 9], "dash": 2, "dashboard": [4, 6], "data": 6, "databas": 9, "dead": 14, "declar": [0, 1, 2, 3, 7, 8, 9, 12, 13, 14, 15, 17, 18], "default": [1, 3, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19], "default_channel": [4, 17], "defin": [0, 1, 2, 3, 6, 9, 10, 12, 15, 18], "define_env_var": 3, "definit": [2, 4, 9, 12], "delet": 4, "deliveri": 0, "delivery_dashboard_url": [9, 15], "demo_break": 10, "depend": [1, 2, 3, 4], "dependency_nam": 18, "dependency_typ": 18, "dependency_vers": 18, "dependend": 3, "deprec": [17, 18], "deriv": 12, "describ": [3, 18], "descript": [4, 15, 18], "descriptor": [2, 9, 12, 14, 15, 18], "detail": 12, "detect": 18, "determin": [2, 3, 6], "dev": 18, "dev_cycle_callback": 14, "develop": [4, 14], "dict": [2, 3, 6, 7, 12, 15, 17, 18], "dictionari": 3, "diff": 14, "differ": [0, 1, 2, 6, 9, 12, 15], "dir": 12, "directori": [3, 12], "disabl": [1, 2, 13, 14], "disable_ci_skip": 2, "discov": [14, 18], "displai": [1, 6], "do": [2, 4, 14], "doc": 4, "docker": 12, "dockerd": 12, "dockerfil": 12, "document": [1, 3, 6, 9, 12], "doe": [0, 2], "don": 6, "done": [0, 2, 3, 6, 12, 14, 18, 19], "down": 6, "draft": 8, "draft_releas": [4, 5], "drop": 6, "dry_run": 6, "dso": 15, "dure": [3, 6, 14, 19], "e": [2, 3, 4, 6, 7, 9, 14, 15, 18], "each": [0, 1, 2, 3, 6, 12, 18], "easier": 4, "easili": 4, "edit": 4, "effect": [2, 6, 7, 8, 12, 14, 19], "effective_vers": [12, 14, 19], "effort": 6, "either": [2, 6, 15], "element": [1, 2, 4, 6], "els": 6, "email": [9, 10, 15], "email_address": 10, "email_recipi": [9, 15], "empti": 1, "enabl": [4, 15], "encompass": 0, "end": [7, 14], "enforc": 14, "enrich": 14, "entri": [6, 12], "enum": 15, "env": [2, 3, 18], "env_var_nam": 3, "environ": [0, 3, 10, 12, 14, 19], "equal": 18, "error": [10, 14, 18], "escap": 3, "escape_argv": 3, "establish": 4, "etc": [9, 15], "eu": [6, 12], "europ": 7, "evalu": [2, 3, 6], "even": 4, "everi": [4, 7, 10], "everyth": 15, "exactli": [3, 6], "exampl": [4, 15], "example_slack_workspac": 4, "exce": 15, "excecut": 12, "except": [12, 15], "exclud": [2, 15], "exclude_path": 15, "exclude_path_regex": 15, "excplicitli": 15, "execut": [0, 2, 3, 6, 7, 12, 13, 16, 18, 19], "executable_with_arg": 3, "executor": 0, "exempt": 6, "exist": [0, 1, 6, 10, 14], "exit": [3, 14, 18], "expans": 3, "expect": [3, 6, 12], "experiment": 3, "explain": 4, "explan": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "explicitli": [2, 6, 12], "expos": [3, 6, 13], "express": [1, 3], "extend": [6, 18], "extens": 1, "extern": 6, "extra_push_target": 12, "extract": 4, "fail": [3, 9, 10, 14, 15], "failur": [3, 14], "fals": [2, 3, 6, 7, 9, 11, 12, 14, 15, 19], "featur": [4, 6], "fetch": [4, 6], "file": [1, 3, 6, 9, 10, 12, 14, 15, 19], "filter": 1, "final": [6, 8, 14, 18, 19], "finish": 3, "first": [4, 6, 10, 14], "first_imag": 12, "first_step": 3, "flag": [1, 4, 6], "follow": [2, 4, 6, 8, 9, 12, 14, 15, 18], "foo": [2, 3, 10], "forbidden": 2, "forc": [2, 3, 12], "force_push": [2, 3], "foremostli": 6, "forget": 6, "form": [3, 7], "format": [6, 7, 9, 15], "found": [1, 6, 9, 15], "fr": 7, "fragment": 1, "frequent": 6, "fridai": 7, "from": [0, 1, 3, 4, 6, 9, 12, 14, 15, 18, 19], "full": [6, 13], "further": 6, "futur": [1, 12], "g": [2, 3, 4, 6, 7, 9, 14, 15, 18], "garden": [0, 1, 2, 4, 6, 12, 15, 18, 19], "gardenlet": 6, "gather": 4, "gcr": [6, 12], "gener": [0, 1, 4, 6, 9, 18], "get": 3, "git": [2, 6], "git_tag": 14, "github": [1, 4, 6, 9, 13, 14, 15, 18], "github_cfg": 2, "github_com": 2, "github_issu": [9, 15], "github_issue_labels_to_preserv": [9, 15], "github_issue_templ": [9, 15], "github_path": 2, "github_wdf_sap_corp": 2, "githubissuetemplatecfg": [9, 15], "given": [2, 3, 6, 12], "glob": 2, "global": 1, "go": [3, 7, 9], "graph": [0, 3], "grc": 12, "great": 18, "greatest": 6, "greatest_cv": [9, 15], "group": [4, 6], "guarante": 12, "guess": 6, "h": [6, 7], "ha": [1, 2, 3, 4, 6, 7, 10, 11, 13, 16, 17, 19], "hack": 15, "handl": [14, 19], "hard": 6, "hash": 19, "have": [3, 4, 6, 9, 13], "head": [1, 2, 4, 6, 7, 14, 19], "header": 6, "helm": 6, "helmchart": 12, "helmchartcfg": 12, "help": [4, 6], "here": [4, 6, 19], "heurist": 6, "hh": 7, "high": [9, 15], "hint": [9, 15], "hold": [4, 12], "honour": 12, "host": [2, 19], "hostnam": 2, "how": [6, 14, 19], "howev": [0, 6], "http": [2, 4], "i": [0, 1, 2, 3, 4, 6, 7, 9, 12, 13, 14, 15, 18, 19], "id": [4, 15], "ideal": 4, "identifi": [2, 6, 9, 18], "iff": [1, 18], "ignor": [2, 6, 7, 12, 14, 18], "ignore_prerelease_vers": 18, "imag": [0, 3, 9, 12, 14, 18], "image_refer": [6, 14, 18], "image_scan": 5, "imagerefer": 6, "immedi": [6, 14, 18], "implement": [6, 12, 18], "impli": [2, 19], "implicitli": 6, "improv": 4, "includ": [2, 4, 6, 9, 12, 15], "include_path": 15, "include_path_regex": 15, "increment": 14, "index": [0, 5], "indic": [6, 12, 18], "influenc": 6, "info": 15, "inform": [4, 13], "infrastructur": 6, "inherit": 4, "inherit_m": 1, "initi": 3, "inject": [6, 19], "inject_effective_vers": 19, "inlin": 6, "input": [2, 3, 6, 10], "input_nam": 3, "insan": 18, "insid": [3, 6, 14], "instal": 6, "instanc": [2, 3], "instanti": 1, "instead": [0, 6], "instrument": 6, "int": [9, 11, 15], "integ": 3, "intend": [6, 18], "interact": 0, "intern": 6, "interpret": [3, 7, 12], "interrupt": [3, 9], "interv": [3, 7, 9], "introduc": 4, "invalid": 18, "invers": 2, "invok": 18, "io": [6, 12], "issu": [9, 10, 15], "issue_polici": [9, 15], "issuepolici": [9, 15], "its": [2, 6], "itself": 2, "job": [0, 3, 4, 6, 7, 8, 9, 12, 13, 14, 16, 18, 19], "job_a": 1, "job_b": 1, "just": [3, 4], "kaniko": [], "kebap": 2, "keep": [1, 6], "kei": 4, "kernel": 12, "know": 4, "known": 4, "kubernet": [2, 4], "label": [2, 6, 9, 12], "landscap": 6, "last": [4, 10], "later": [9, 18], "latest": [12, 14, 18], "latter": 6, "layer": 9, "layout": 6, "lead": [6, 14], "least": [1, 12, 14], "leav": 6, "left": 14, "legaci": 6, "level": 1, "like": [3, 4, 6, 18], "limit": [6, 7], "linux": 12, "list": [1, 2, 3, 6, 7, 9, 10, 12, 13, 14, 15, 17, 18], "littl": 6, "local_dependency_nam": 18, "locat": 6, "log": 11, "logic": [2, 3, 9, 12, 18], "look": [1, 4], "lookup": 6, "low": [9, 15], "m": 7, "made": [2, 10, 12, 19], "mai": [0, 1, 2, 3, 6, 9, 10, 12, 18], "mail": 10, "main": [3, 7, 10, 12, 13, 14, 19], "main_repo": [3, 18], "main_repo_dir": 2, "main_repositori": 18, "major": 14, "make": [4, 6, 13], "malici": 13, "mandatori": 1, "mani": 6, "manual": [6, 14, 18], "map": [3, 6], "mark": 9, "master": [1, 2], "match": [1, 6, 9, 15], "matching_config": 9, "materi": 6, "max_processing_time_dai": [9, 15], "maximum": [3, 9, 15], "maxmimum": 9, "me": 6, "mean": [9, 13], "mechan": [4, 6], "medium": [9, 15], "mention": 9, "merg": [4, 14, 18], "merge_release_to_default_branch_commit_message_prefix": 14, "mergemethod": [], "mergepolici": 18, "mergepolicyconfig": 18, "messag": [4, 14], "meta": [1, 6], "method": [], "might": [3, 6], "mind": 6, "minor": [6, 14], "minut": 7, "mitig": 13, "mm": 7, "mnt": 18, "mo": 7, "mode": [3, 6], "model": 14, "modifi": 18, "mondai": 7, "more": [10, 13], "most": [3, 4, 6, 9, 10], "mostli": 6, "mount": 18, "msg": 2, "multi": [6, 12], "multiarch": 12, "multipl": [6, 12], "multistag": 12, "must": [2, 3, 6, 10, 12, 15, 18, 19], "my": 4, "my_important_valu": 3, "my_pipelin": 1, "my_repo": [2, 3], "my_repo_path": 2, "my_script": 3, "my_slack_channel": 17, "my_slack_channel_nam": 4, "mycloud": 10, "name": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "namespac": 1, "narrow": 6, "nativ": 0, "necessarili": 6, "need": [4, 6, 13], "never": [9, 10, 15], "new": 4, "newer": 18, "next": [4, 14], "next_version_callback": 14, "next_version_commit_message_prefix": 14, "nextvers": [1, 4], "nobodi": [9, 15], "node": 12, "non": [1, 2, 3, 14], "none": [2, 3, 4, 6, 7, 9, 12, 14, 15, 16, 17, 18, 19], "noop": [14, 19], "notabl": [4, 12], "note": [8, 14, 17], "noteworthi": 4, "notif": [3, 5], "notifi": 10, "notificationrecipi": 10, "notifications_cfg": 3, "notificationtriggeringpolici": 10, "notifii": 10, "notify_cfg_out": 10, "now": 4, "null": 12, "number": 13, "o": 6, "obsolet": 6, "obviou": 13, "occur": [11, 14], "occurr": 2, "oci": [6, 9, 14, 18], "ocibuild": 12, "ociimag": 6, "ociregistri": 6, "ocm": 6, "ocm_repo_url": 6, "ocm_repositori": 6, "ocm_repository_map": 6, "ocmrepositorymappingentri": 6, "offer": [0, 6, 18], "ok": 13, "omit": [1, 2], "on_abort": 3, "on_error_dir": 10, "onc": [4, 6], "one": [1, 3, 12, 14, 18], "ones": 18, "onli": [1, 2, 3, 4, 6, 10, 12, 13, 15, 18, 19], "onlin": 6, "only_first": 10, "open": 4, "oper": [0, 4, 8, 9, 14, 19], "opinion": 6, "option": [1, 2, 3, 4, 5, 6, 9, 10, 12, 15], "order": [0, 4, 6, 12], "org": 6, "organis": 1, "origin": 6, "other": [2, 3, 4, 6, 12, 18], "otherwis": [1, 2, 9, 12], "ought": 2, "our": [0, 4], "out": [3, 6, 15], "out_path": 3, "outdat": 18, "output": [3, 6, 12, 18], "output_dir": [3, 12], "output_nam": 3, "over": [4, 6, 12], "overwrit": [2, 6, 9, 15], "overwrite_github_issues_tgt_repository_url": [9, 15], "overwritten": [6, 9], "own": [1, 6], "packag": 6, "pair": 3, "parallel": [3, 9, 16], "parallel_job": 9, "part": 6, "pass": [3, 12, 14], "patch": 14, "patchlevel": 14, "path": [2, 3, 6, 10, 12, 14, 18, 19], "path_config": 15, "payload": 3, "per": 3, "perform": [6, 9, 14, 15], "period": [6, 7], "persist": 14, "pgk": 15, "phase": 6, "pip3": 6, "pipelin": [4, 6, 19], "pipeline_definit": [0, 6], "pipeline_descriptor": 3, "pipeline_model": 3, "pkg": 15, "place": [1, 3, 6, 12], "placehold": 14, "platform": 12, "polici": [3, 9, 10, 14, 15, 18], "posit": [3, 9], "possibl": [2, 4, 6, 10], "post": [13, 14], "potenti": 3, "ppc64le": 12, "pr": [13, 18], "pre": 6, "prebuild_hook": 12, "predefin": 6, "prefer": [2, 4, 6], "prefix": [6, 14], "prepar": 12, "preprocess": [8, 12, 14], "prereleas": 18, "prerequisit": 12, "presenc": [2, 7], "present": [1, 2, 6, 9, 12, 14, 15], "prevent": 16, "previou": 14, "principl": 0, "prior": [6, 12], "privat": 2, "privileg": 3, "privilegemod": 3, "process": [6, 8, 9, 13, 15], "produc": [3, 6], "productutil": 6, "progress": 6, "project": [0, 6, 12], "promin": 10, "propos": 4, "protocol": 2, "provid": [2, 6], "public_build_log": 11, "publish": [0, 3, 5, 6, 14, 17], "publish_commit": 3, "publish_to": 3, "pull": [2, 5, 6, 18], "pullrequest_id": 13, "pullrequest_url": 13, "push": [2, 3, 4, 12, 14], "push_to_branch": 14, "put": 4, "pwd": 3, "py": 6, "python": [3, 6], "python3": [6, 9, 15, 18], "pythonpath": 18, "quemu": 12, "question": 6, "rang": 7, "re": [1, 6], "react": [2, 13], "read": [2, 19], "read_callback": 19, "reason": [1, 6, 13, 18, 19], "rebas": 14, "rebase_before_releas": 14, "receiv": [12, 18], "recipi": [9, 15], "recommend": [14, 18], "recurs": 6, "reduc": 12, "ref": [1, 6, 14], "ref_templ": 14, "refer": [1, 2, 3, 6, 12, 14, 18], "referenc": [2, 6, 12], "refrain": 1, "regex": [9, 15], "registri": [3, 6, 12], "regular": [1, 6, 19], "reject": 18, "rel": [2, 3, 7, 10, 12, 14, 19], "relat": 6, "relax": 6, "releas": [2, 5, 6, 8, 12, 17, 18], "release_callback": 14, "release_on_github": 14, "releasecommitpublishingpolici": 14, "releasenotespolici": 14, "relev": [4, 6, 14], "remot": 4, "remov": [3, 6, 9, 13, 15, 18, 19], "render": 1, "render_pipelin": 1, "repeat": 13, "replac": [6, 13], "replic": 3, "repo": [2, 6, 12, 18, 19], "repo_dir": [14, 18], "repo_path": 2, "repo_root": 10, "report": 13, "report_url": [9, 15], "repositori": [1, 3, 4, 6, 7, 9, 10, 12, 13, 14, 15, 17, 18, 19], "request": [2, 5, 6, 18], "requir": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "rescan": 9, "rescor": 9, "resid": [1, 2], "resolv": 6, "resolve_depend": 6, "resourc": [6, 9, 12, 15], "resource_label": 12, "resource_nam": [9, 15], "resource_typ": [9, 15], "resource_vers": [9, 15], "restrict": [2, 6], "result": [0, 1, 3, 6, 9, 10, 12, 13, 14, 15], "retain": 11, "retention_polici": 6, "retentions_polici": 6, "retri": 3, "retriev": [3, 6, 9], "return": [18, 19], "reus": 4, "review": 13, "riscv64": 12, "risk": 13, "root": [1, 2, 6, 10, 12, 14], "rotat": 11, "rule": 6, "run": [0, 2, 3, 6, 7, 9, 12, 14], "runtim": [6, 13, 18], "s3": 9, "s390x": 12, "said": [6, 13, 14], "same": [1, 2, 3, 6, 12, 16], "sane": 18, "saturdai": 7, "save": 14, "scalar": 3, "scan": [1, 9, 15], "scan_sourc": 5, "scan_timeout": 15, "scenario": 1, "schedul": [0, 5], "scheme": 6, "scp_workspac": 17, "script": [6, 18], "search": 1, "second": [3, 4, 15], "second_imag": 12, "section": 4, "secur": 13, "see": [1, 3, 4, 6, 9, 10, 12, 14, 17], "self": 0, "semant": [0, 1, 14, 18], "semver": [6, 18, 19], "send": 10, "separ": 18, "sequenc": [], "server": 2, "servic": 0, "set": [0, 2, 3, 7, 8, 9, 12, 13, 14, 15, 18, 19], "set_dependency_vers": 18, "set_dependency_version_script": 18, "severity_threshold": 15, "shall": 13, "share": [1, 6, 12], "shell": [3, 6], "short": [1, 6], "shorten": 14, "shortliv": 6, "should": [1, 2, 3, 4, 6, 12, 14, 15, 16, 18], "shown": 4, "signal": 18, "similar": [6, 18], "simpli": 6, "sinc": 4, "singl": [7, 12], "skip": [2, 15], "sla": [9, 15], "slack": [5, 14], "slack_cfg_nam": [4, 17], "smallest": 6, "snake": 2, "snake_cas": 3, "snapshot": 6, "so": [1, 4], "some": [0, 3, 6], "someon": 6, "sourc": [0, 1, 2, 3, 4, 6, 12, 15, 19], "source_analysi": 15, "source_branch": 2, "source_github_repo_owner_and_nam": 2, "source_label": 2, "source_path": 2, "sourcerepositori": 6, "special": 1, "specif": [2, 6, 10, 14, 18], "specifi": [2, 3, 4, 6, 7, 9, 12, 14, 15, 18], "squash": [], "src": 15, "ssh": 2, "stale": 6, "standardis": [0, 6], "start": [4, 6, 7, 13], "static": 12, "statu": 13, "stdin": 19, "stdout": 19, "step": [0, 1, 2, 4, 6, 9, 10, 13, 14, 18], "step_nam": 3, "stepinput": 6, "still": 4, "store": [2, 6], "str": [2, 3, 6, 7, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19], "strictly_follow": 18, "string": [6, 7], "strongli": 14, "style": [3, 7, 9], "sub": [9, 15], "subject": [6, 9], "submodul": 2, "submodule_cfg_nam": 2, "subprocess": [10, 14], "subsequ": [3, 8, 13], "subset": 12, "succeed": 3, "success": 3, "successor": 6, "suffix": [7, 12, 19], "summari": [9, 15], "sundai": 7, "support": [2, 4, 6, 7, 12], "suppress_parallel_execut": 16, "sure": 1, "symbol": 3, "syntax": [2, 9, 15], "system": [6, 9], "t": 6, "tabl": [9, 15], "tag": [4, 6, 12, 14], "tag_and_merge_back": 14, "tag_as_latest": 12, "tag_onli": 14, "tag_templ": 12, "tagconflictact": 14, "tailor": 6, "take": 14, "target": [4, 9, 12, 15, 18], "target_group": 4, "targetspec": 12, "tbd": 15, "team": [1, 15], "team_id": 15, "technologi": 0, "tell": 6, "templat": [1, 4, 6, 9, 12, 15], "termin": 6, "test": [0, 13, 15], "text": 4, "than": 18, "thei": [2, 6, 12], "them": [3, 13, 14], "themselv": 3, "therefor": [2, 6, 18], "thi": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "thing": 6, "those": [2, 6, 9, 12, 13], "threshold": 15, "through": [0, 3], "thu": [4, 6, 12, 13, 14], "thursdai": 7, "ticket": [9, 15], "time": [3, 6, 7, 9, 12, 14, 15], "timeout": [3, 9, 15], "timerang": 7, "timezon": 7, "tool": [6, 9, 14, 18], "toolchain": 6, "top": 1, "toplevel": 12, "touch": 2, "toward": [3, 6], "trait": [0, 1, 2, 3, 4], "trait_depend": [3, 9], "tree": [1, 2, 3, 6, 12, 14, 18, 19], "tri": 6, "trigger": [7, 9, 10, 13, 14, 15], "true": [1, 2, 3, 6, 10, 12, 14, 15, 16, 18], "try": 1, "tuesdai": 7, "tupl": [], "turn": 13, "two": [1, 3, 4, 7, 12], "type": [2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "typic": [0, 6], "ui": 1, "unauthent": 11, "unchang": 3, "undefin": [2, 18], "underli": [0, 6, 12], "underscor": 2, "uniqu": 3, "unknown": 18, "unless": 9, "unprivileg": 3, "unresolv": 6, "until": 3, "untrust": 3, "up": [1, 12], "updat": [2, 4, 6, 7, 8, 9, 13, 14, 15, 18], "update_component_dep": 5, "uploadmod": 6, "upon": [4, 9, 10, 13, 15, 17, 18], "upper": [2, 3], "upper_cas": 3, "upstream": 18, "upstream_component_nam": 18, "upstream_update_polici": 18, "url": [6, 13], "us": [0, 1, 2, 3, 4, 7, 9, 10, 12, 14, 15, 17, 18, 19], "usag": [1, 2], "user": [1, 2, 4, 11], "usual": 4, "util": [6, 18], "v1": 15, "v2": 6, "v6": 12, "v7": 12, "valid": [1, 2, 6, 19], "validation_polici": 6, "valu": [1, 4], "var": [3, 18], "variabl": [3, 9, 10, 12, 14, 15, 19], "variant": [9, 12], "varieti": 0, "verbatim": 3, "veri": 4, "version": [4, 5, 8, 9, 12, 14, 15, 18], "version_path": 19, "versionfil": 19, "versioninterfac": 19, "versionretentionpolici": 6, "very_high_or_great": [9, 15], "via": [3, 6, 14, 18, 19], "view": 4, "virtualis": 14, "viru": 9, "virus_db_max_age_dai": 9, "vpn": 6, "w": 6, "wa": [2, 4, 6, 13], "wai": [6, 18], "we": [0, 4], "web": 18, "wednesdai": 7, "weekdai": 7, "well": [0, 3], "were": 18, "when": [1, 3, 4, 6, 9, 10, 12, 14, 15], "whera": 3, "where": [4, 6], "wherea": 13, "whether": [2, 3, 6, 10, 11, 12, 14, 15, 16, 18, 19], "which": [0, 2, 3, 4, 6, 7, 9, 12, 13, 14, 15], "while": 14, "whitespac": [1, 3], "whole": 15, "whom": [9, 10, 15], "within": [0, 1, 4, 6, 12, 18], "without": [0, 3, 12], "word": 2, "work": [2, 3, 6, 12, 14, 18], "worker": 9, "working_dai": 7, "working_hour": 7, "workload": 0, "workspac": 4, "worktre": [1, 3, 14], "would": [1, 4], "writabl": 3, "write": [4, 10, 19], "write_callback": 19, "writeabl": 18, "written": 19, "x86_64": 12, "yaml": 1, "ye": [9, 12, 14, 15, 17, 18], "yet": 6, "you": [4, 6], "your": [3, 4, 15], "zero": [3, 14, 18]}, "titles": ["CC-Utils - Build Pipeline Reference Manual", "Pipeline Definition", "Pipeline Job", "Pipeline Steps", "Release Notes Process", "Pipeline Definition Traits", "component_descriptor Trait", "cronjob Trait", "draft_release Trait", "image_scan Trait", "notifications Trait", "options Trait", "publish Trait", "pull-request Trait", "release Trait", "scan_sources Trait", "scheduling Trait", "slack Trait", "update_component_deps Trait", "version Trait"], "titleterms": {"To": 4, "add": 6, "addit": [2, 6], "aka": 6, "attribut": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "base_definit": 1, "behaviour": [2, 18], "branch": 1, "build": [0, 12], "builder": 12, "callback": 14, "case": 6, "categori": 4, "cc": 0, "cfg_name": 2, "chart": 6, "checkmarx": 15, "checkmarxcfg": 15, "chosen": 12, "ci": 1, "clam_av": 9, "clamavscancfg": 9, "clean": 6, "cleanup": 6, "cli": 6, "command": 6, "commit": 4, "compon": [6, 18], "component_descriptor": 6, "concept": 0, "configur": 1, "contract": [6, 14, 18], "contribut": 4, "cronjob": 7, "cycl": 14, "declar": 6, "default": [2, 6, 10], "definit": [0, 1, 5], "depend": [6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "deprec": 6, "descriptor": 6, "dev": 14, "develop": 6, "dockerimag": 12, "draft": 4, "draft_releas": 8, "enumer": [2, 3, 6, 9, 10, 12, 14, 15, 18, 19], "environ": [2, 6, 18], "exampl": [1, 2, 3, 6, 7, 10, 12, 13, 14, 16, 17], "extens": 18, "filter": 15, "filtercfg": 15, "format": 4, "from": 2, "github": 2, "handl": [6, 13], "hotfix": 1, "how": 4, "imag": 6, "image_scan": 9, "imagevector": 6, "implicitli": 12, "indic": [0, 5], "inherit": 1, "inject": 12, "input": 12, "introduct": 0, "job": [1, 2], "label": [13, 15], "local": 6, "main": 2, "manual": 0, "map": 4, "merge_method": [], "merge_mod": [], "merge_polici": 18, "mergepolicyconfig": [], "nextvers": 14, "note": [4, 18], "notif": 10, "notifi": [9, 15], "notificationcfg": 10, "notificationcfgset": 10, "oci": 12, "ociimagecfg": [14, 18], "old": 6, "on_error": 10, "on_tag_conflict": 14, "option": [11, 14], "os_id": 9, "osidscan": 9, "pass": [6, 18], "path": 15, "pipelin": [0, 1, 2, 3, 5], "pipeline_definit": 1, "polici": [6, 13], "post": 4, "preferred_protocol": 2, "preliminari": 6, "preprocess": 19, "privilege_mod": 3, "process": 4, "protecod": 15, "publish": 12, "publishdockerimagedescriptor": 12, "pull": [4, 13], "pullrequestpolici": 13, "recipi": 10, "refer": 0, "releas": [1, 4, 14], "release_callback_image_refer": 14, "release_commit_publishing_polici": 14, "release_notes_polici": 14, "render": 6, "repositori": 2, "request": [4, 13], "retent": 6, "scan_sourc": 15, "schedul": 16, "schema": 1, "schemat": 1, "semant": [6, 15], "set": 6, "set_dependency_version_script_container_imag": 18, "slack": [4, 17], "special": 6, "specif": 1, "step": [3, 12], "support": 15, "tabl": [0, 5], "term": 0, "titl": 4, "trait": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "transport": 4, "trigger": 2, "trigger_path": 2, "triggering_polici": 10, "up": 6, "update_component_dep": 18, "upgrad": 18, "upload": 6, "us": 6, "user": 12, "util": 0, "valu": [2, 3, 6, 9, 10, 12, 14, 15, 18, 19], "variabl": [2, 6, 18], "version": [6, 19], "version_interfac": 19, "yaml": 6}}) \ No newline at end of file +Search.setIndex({"alltitles": {"(GitHub) Repositories": [[2, "github-repositories"]], "Additional Repositories": [[2, "additional-repositories"]], "Attributes": [[1, "attributes"], [1, "id1"], [2, "attributes"], [2, "repository-config"], [3, "pipeline-step"], [6, "trait-component-descriptor"], [7, "trait-cronjob"], [8, "trait-draft-release"], [9, "trait-image-scan"], [10, "trait-notifications"], [11, "trait-options"], [12, "trait-publish"], [13, "trait-pullrequest"], [14, "trait-release"], [15, "trait-scan-sources"], [16, "trait-scheduling"], [17, "trait-slack"], [18, "trait-update-component-deps"], [19, "trait-version"]], "Behavioural Contract": [[18, "behavioural-contract"]], "Branch-specific configuration": [[1, "branch-specific-configuration"]], "CC-Utils - Build Pipeline Reference Manual": [[0, null]], "Category - Title Mapping": [[4, "category-title-mapping"]], "Cleanup Semantics and Use-Case": [[6, "cleanup-semantics-and-use-case"]], "Commits": [[4, "commits"]], "Component Upgrade Contract": [[18, "component-upgrade-contract"]], "Contract": [[14, "contract"], [14, "id1"]], "Declaring Additional Dependencies": [[6, "declaring-additional-dependencies"]], "Default Component Descriptor": [[6, "default-component-descriptor"]], "Default behaviour for trigger attribute": [[2, "default-behaviour-for-trigger-attribute"]], "Dependencies": [[6, "trait-component-descriptor"], [7, "trait-cronjob"], [8, "trait-draft-release"], [9, "trait-image-scan"], [10, "trait-notifications"], [11, "trait-options"], [12, "trait-publish"], [13, "trait-pullrequest"], [14, "trait-release"], [15, "trait-scan-sources"], [16, "trait-scheduling"], [17, "trait-slack"], [18, "trait-update-component-deps"], [19, "trait-version"]], "Draft Release": [[4, "draft-release"]], "Environment Variables": [[2, "environment-variables"]], "Environment Variables Passed to component_descriptor": [[6, "environment-variables-passed-to-component-descriptor"]], "Environment Variables from repositories": [[2, "environment-variables-from-repositories"]], "Example": [[2, "example"], [6, "example"], [6, "id1"], [7, "example"], [10, "example"], [12, "example"], [13, "example"], [14, "example"], [14, "id2"], [16, "example"], [17, "example"]], "Example (hotfix-branch release jobs)": [[1, "example-hotfix-branch-release-jobs"]], "Example (schematic)": [[1, "example-schematic"]], "Example - Inheritance / \u201cbase_definition\u201d": [[1, "example-inheritance-base-definition"]], "Example .ci/pipeline_definitions": [[1, "example-ci-pipeline-definitions"]], "Examples": [[2, "examples"], [3, "examples"]], "Extension Note": [[18, "extension-note"]], "Format": [[4, "format"]], "How to Contribute to Release Notes": [[4, "how-to-contribute-to-release-notes"]], "Indices and Tables": [[5, "indices-and-tables"]], "Indices and tables": [[0, "indices-and-tables"]], "Introduction": [[0, "introduction"]], "Local Development and \u201ccomponent-cli\u201d": [[6, "local-development-and-component-cli"]], "Main Repository": [[2, "main-repository"]], "Optional Dev Cycle Callback": [[14, "optional-dev-cycle-callback"]], "Optional Release Callback": [[14, "optional-release-callback"]], "Passed Environment Variables": [[18, "passed-environment-variables"]], "Path filtering semantics": [[15, "path-filtering-semantics"]], "Pipeline Definition": [[1, null]], "Pipeline Definition Schema": [[1, "pipeline-definition-schema"]], "Pipeline Definition Traits": [[5, null]], "Pipeline Job": [[2, null]], "Pipeline Steps": [[3, null]], "Policies / Pull-Request Label Handling": [[13, "policies-pull-request-label-handling"]], "Posting Release Notes To Slack": [[4, "posting-release-notes-to-slack"]], "Pull Requests": [[4, "pull-requests"]], "Release Notes Process": [[4, null]], "Rendering Component-Descriptor": [[6, "rendering-component-descriptor"]], "Repository Attributes": [[2, "repository-attributes"]], "Retention Policies (aka cleaning up old versions)": [[6, "retention-policies-aka-cleaning-up-old-versions"]], "Setting up Preliminaries": [[6, "setting-up-preliminaries"]], "Special-handling for \u201ccharts/images.yaml\u201d / deprecating component-cli": [[6, "special-handling-for-charts-images-yaml-deprecating-component-cli"]], "Supported labels": [[15, "supported-labels"]], "Terms, Definitions and Concepts": [[0, "terms-definitions-and-concepts"]], "Transporting Release Notes": [[4, "transporting-release-notes"]], "cfg_names attribute": [[2, "cfg-names-attribute"]], "checkmarx": [[15, "checkmarx"]], "checkmarx (CheckmarxCfg) Attributes": [[15, "trait-scan-sources"]], "clam_av (ClamAVScanCfg) Attributes": [[9, "trait-image-scan"]], "component_descriptor Trait": [[6, null]], "cronjob Trait": [[7, null]], "default (NotificationCfgSet) Attributes": [[10, "trait-notifications"]], "default.on_error (NotificationCfg) Attributes": [[10, "trait-notifications"]], "default.on_error.recipients Enumeration Values": [[10, "trait-notifications"]], "default.on_error.triggering_policy Enumeration Values": [[10, "trait-notifications"]], "dockerimages. (PublishDockerImageDescriptor) Attributes": [[12, "trait-publish"]], "draft_release Trait": [[8, null]], "filters (FilterCfg) Attributes": [[15, "trait-scan-sources"]], "image_scan Trait": [[9, null]], "implicitly injected build steps": [[12, "implicitly-injected-build-steps"]], "inputs Attribute": [[12, "inputs-attribute"]], "merge_policy Enumeration Values": [[18, "trait-update-component-deps"]], "nextversion Enumeration Values": [[14, "trait-release"]], "notifications Trait": [[10, null]], "notify Enumeration Values": [[9, "trait-image-scan"], [15, "trait-scan-sources"]], "oci-builder Enumeration Values": [[12, "trait-publish"]], "on_tag_conflict Enumeration Values": [[14, "trait-release"]], "options Trait": [[11, null]], "os_id (OsIdScan) Attributes": [[9, "trait-image-scan"]], "policies (PullRequestPolicies) Attributes": [[13, "trait-pullrequest"]], "preferred_protocol Enumeration Values": [[2, "repository-config"]], "preprocess Attribute": [[19, "preprocess-attribute"]], "privilege_mode Enumeration Values": [[3, "pipeline-step"]], "protecode": [[15, "protecode"]], "publish Trait": [[12, null]], "pull-request Trait": [[13, null]], "release Trait": [[14, null]], "release_callback_image_reference (OciImageCfg) Attributes": [[14, "trait-release"]], "release_commit_publishing_policy Enumeration Values": [[14, "trait-release"]], "release_notes_policy Enumeration Values": [[14, "trait-release"]], "scan_sources Trait": [[15, null]], "scheduling Trait": [[16, null]], "set_dependency_version_script_container_image (OciImageCfg) Attributes": [[18, "trait-update-component-deps"]], "slack Trait": [[17, null]], "trigger_paths attribute": [[2, "trigger-paths-attribute"]], "update_component_deps Trait": [[18, null]], "upload Enumeration Values": [[6, "trait-component-descriptor"]], "version Trait": [[19, null]], "version_interface Enumeration Values": [[19, "trait-version"]], "\u201cimagevector add\u201d command / charts/images.yaml contract": [[6, "imagevector-add-command-charts-images-yaml-contract"]]}, "docnames": ["index", "pipeline", "pipeline_job", "pipeline_step", "release_notes", "traits", "traits/component_descriptor", "traits/cronjob", "traits/draft_release", "traits/image_scan", "traits/notifications", "traits/options", "traits/publish", "traits/pullrequest", "traits/release", "traits/scan_sources", "traits/scheduling", "traits/slack", "traits/update_component_deps", "traits/version"], "envversion": {"sphinx": 62, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "pipeline.rst", "pipeline_job.rst", "pipeline_step.rst", "release_notes.rst", "traits.rst", "traits/component_descriptor.rst", "traits/cronjob.rst", "traits/draft_release.rst", "traits/image_scan.rst", "traits/notifications.rst", "traits/options.rst", "traits/publish.rst", "traits/pullrequest.rst", "traits/release.rst", "traits/scan_sources.rst", "traits/scheduling.rst", "traits/slack.rst", "traits/update_component_deps.rst", "traits/version.rst"], "indexentries": {"component_descriptor": [[6, "trait-component-descriptor", false]], "cronjob": [[7, "trait-cronjob", false]], "draft_release": [[8, "trait-draft-release", false]], "image_scan": [[9, "trait-image-scan", false]], "modelelement": [[2, "repository-config", false], [3, "pipeline-step", false]], "notifications": [[10, "trait-notifications", false]], "options": [[11, "trait-options", false]], "pipeline step": [[3, "pipeline-step", false]], "publish": [[12, "trait-publish", false]], "pullrequest": [[13, "trait-pullrequest", false]], "release": [[14, "trait-release", false]], "repository config": [[2, "repository-config", false]], "scan_sources": [[15, "trait-scan-sources", false]], "scheduling": [[16, "trait-scheduling", false]], "slack": [[17, "trait-slack", false]], "trait": [[6, "trait-component-descriptor", false], [7, "trait-cronjob", false], [8, "trait-draft-release", false], [9, "trait-image-scan", false], [10, "trait-notifications", false], [11, "trait-options", false], [12, "trait-publish", false], [13, "trait-pullrequest", false], [14, "trait-release", false], [15, "trait-scan-sources", false], [16, "trait-scheduling", false], [17, "trait-slack", false], [18, "trait-update-component-deps", false], [19, "trait-version", false]], "update_component_deps": [[18, "trait-update-component-deps", false]], "version": [[19, "trait-version", false]]}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": [1, 2, 3, 6, 7, 9, 12, 14, 15, 18, 19], "0": [4, 6, 9, 15, 18], "00": 7, "04": 6, "06": 6, "08": 7, "09": 7, "1": [4, 6, 18], "10": 6, "100": 6, "1000": 11, "120": [9, 15], "128": 6, "13": 7, "147": 4, "18": [4, 7], "18h": 9, "1h30m": [3, 9], "2": [6, 18], "20": 1, "2023": 6, "2h": 9, "3": [3, 6, 18], "30": [7, 9, 15], "3600": 15, "386": 12, "4": 6, "42": 7, "42m": 7, "45": 7, "5": 6, "5m": 7, "6": [3, 6], "64": 6, "67": 6, "8": 9, "90": [9, 15], "A": [1, 3, 4, 6, 7], "As": [0, 4, 12], "By": [1, 3, 12, 18], "For": [1, 2, 6, 13, 18], "If": [1, 2, 3, 4, 6, 7, 9, 12, 14, 15, 17], "In": [0, 2, 4, 6, 9, 18], "It": [2, 3, 4, 6, 12, 18], "No": 14, "On": 4, "One": [6, 15, 17], "Such": 14, "The": [1, 2, 3, 4, 6, 7, 9, 12, 14, 15, 18], "There": [4, 6], "To": [6, 12, 13], "_": 2, "_after_": 12, "_all_": 12, "_branch": 2, "_default_": 6, "_github_repo_owner_and_nam": 2, "_may_": 12, "_path": [2, 3, 12], "_permanent_": 6, "abc": 18, "abort": [3, 9], "about": [9, 13, 15], "abov": [2, 4, 6, 18], "absent": [6, 15], "absolut": [6, 10, 12, 14, 18], "abstract": 0, "acccord": 6, "accept": [3, 9, 19], "access": [3, 4, 6, 9, 11, 12], "accur": 6, "achiev": 4, "action": [4, 14, 15], "actual": 3, "ad": [4, 6, 13, 14], "add": [0, 2, 3, 4, 12, 14, 19], "add_depend": 6, "add_dependencies_cmd": 6, "addit": [3, 12, 14], "address": 10, "adher": 1, "affect": [2, 7], "after": [3, 6, 9, 13, 14, 18], "after_merge_callback": 18, "ag": 9, "again": [4, 12, 13], "against": 14, "aka": 12, "all": [0, 1, 2, 3, 4, 6, 9, 12, 15, 18], "allow": [2, 3, 12], "along": [6, 18], "alphanumer": [1, 2], "alpin": [3, 6], "alreadi": [1, 4, 14], "also": [3, 6, 12, 18], "although": 0, "altogeth": 4, "alwai": [2, 10, 12], "amd64": 12, "among": 6, "amount": [1, 2, 3, 6, 9, 11, 12], "an": [0, 1, 2, 3, 4, 6, 10, 12, 14, 18, 19], "an_env_var": 3, "ani": [1, 2, 3, 6, 14, 18], "anoth": [1, 3, 6], "another_execut": 3, "another_ocm_repo_url": 6, "another_pipelin": 1, "another_repo": 3, "another_step": 1, "anotherdockerfil": 12, "anymor": 4, "api": 4, "appear": 4, "appli": [1, 13, 15, 18], "ar": [0, 1, 2, 3, 4, 6, 7, 9, 10, 11, 12, 13, 14, 17, 18, 19], "arbitrari": [1, 2, 3, 12], "arch": [6, 12], "architectur": 12, "arg": [3, 6], "argument": [3, 12, 18], "argv": 3, "arithmet": 6, "arm": 12, "arm64": 12, "around": 0, "artefact": 6, "articl": 4, "artifact": [6, 15], "ascii": [1, 2], "asset": [6, 14], "assign": 3, "assum": [6, 18], "attr": [3, 9, 15], "auth": 2, "authent": [2, 3], "auto": 18, "auto_merg": 18, "autom": [0, 6], "automat": [4, 6, 8, 18, 19], "avail": [2, 3, 6, 9, 10, 12, 14, 15, 18, 19], "avoid": [14, 18], "aw": 9, "aws_cfg_nam": 9, "back": 14, "backup": 6, "backward": [6, 14], "bar": [2, 10], "base": [2, 4, 6, 12], "base_definition_path": 6, "base_url": 6, "basi": 4, "bazz": 10, "been": [2, 6], "befor": [6, 9, 11, 14], "begin": [7, 13], "behaviour": [6, 7, 12, 14], "being": [1, 6, 9, 13], "below": [1, 2, 4, 6, 10], "berlin": 7, "between": [3, 7], "bewar": 3, "bill": 6, "binary_path": 12, "blob": 6, "block": 4, "blocker": [9, 15], "blow": 10, "bodi": [9, 15], "bool": [2, 3, 6, 10, 11, 12, 14, 15, 16, 18, 19], "both": [6, 12], "bound": 4, "branch": [2, 6, 14, 19], "break": 4, "bugfix": 4, "build": [1, 2, 3, 4, 6, 7, 9, 10, 11, 13, 14, 19], "build_and_expose_output": 3, "build_arg": 12, "build_dir": 12, "build_logs_to_retain": 11, "build_result": 12, "build_result_dir": 3, "build_result_path": 12, "buildkit": 12, "buildstepfileasset": 14, "buildsteplogasset": 14, "buildx": 12, "built": [6, 12], "bump": 14, "bump_major": 14, "bump_minor": [1, 4, 14], "bump_patch": [1, 14], "buzz": 10, "c": 6, "cach": 3, "cache_path": 3, "calcul": [3, 14, 19], "call": [6, 10, 14, 18], "callback": [6, 10, 12, 18, 19], "callback_env": 6, "can": [4, 6, 12, 14, 19], "cannot": [3, 4], "care": 6, "carefulli": 3, "case": [2, 3, 4, 9, 10, 12, 14, 18], "caution": 3, "cautiou": 4, "cc": [2, 6, 9, 17, 18], "cd": 0, "central": 0, "certain": [0, 2, 9], "cfg": [1, 6, 9, 10], "cfg_callback": 10, "cfg_name": [1, 3, 15], "chang": [0, 2, 3, 4, 7, 12, 13, 14, 18, 19], "channel": [4, 17], "channel_cfg": [4, 17], "channel_nam": [4, 17], "channelconfig": 17, "char": 1, "charact": [2, 3], "charat": 1, "chdir": 6, "check": 18, "chosen": [1, 2, 14], "ci": [0, 2, 3, 6, 18], "cicd": [6, 12], "clamav": 9, "clamav_cfg_nam": 9, "clamavrescoringentri": 9, "clean": 18, "close": 6, "cloud": [6, 15], "cmd": 6, "cnudi": 15, "code": [3, 4, 6, 14, 18], "codeown": 10, "collect": [6, 8], "com": [2, 4, 6, 10, 18], "commit": [2, 3, 10, 14, 19], "commit_message_prefix": 14, "committ": 10, "common": [1, 12], "commun": 4, "compar": [9, 18], "compat": [6, 14, 19], "compil": 6, "complianc": 15, "compon": [0, 1, 2, 3, 4, 9, 10, 12, 14, 15, 19], "component_descriptor": [5, 8, 9, 14, 15, 18], "component_descriptor_dir": 10, "component_descriptor_path": 6, "component_diff_own": 10, "component_label": 6, "component_nam": [6, 9, 15], "component_own": [9, 15], "component_vers": [6, 9, 15], "concours": [0, 1, 2, 4, 14], "config": [2, 4, 9, 12, 15, 17], "configur": [2, 3, 4, 6, 7, 9, 10, 12, 13, 14, 15, 17, 18], "conflict": 14, "conjunct": 12, "consid": [1, 4, 6, 14, 15], "construct": 2, "consum": 12, "consumpt": 12, "contain": [0, 1, 3, 4, 6, 9, 12, 13, 14, 15, 18], "container_imag": 18, "content": [9, 12], "context": [0, 6], "continu": 0, "contract": 0, "contribut": 0, "conveni": 6, "convent": [6, 18], "convert": [2, 3, 6], "copi": 12, "correspond": [2, 4, 13], "count": 3, "cp": [6, 12], "creat": [3, 4, 6, 8, 12, 14, 15, 18], "creation": [13, 14, 18], "critic": [9, 15], "cronjob": [2, 5], "cross": 12, "ctx": 6, "ctx_repositori": 6, "ctx_repository_base_url": 6, "cumbersom": 6, "current": [1, 3, 6, 9, 18, 19], "custom": [9, 14, 15], "custom_execut": 3, "custom_imag": 3, "customis": [0, 6, 10], "dai": [7, 9], "dash": 2, "dashboard": [4, 6], "data": 6, "databas": 9, "dead": 14, "declar": [0, 1, 2, 3, 7, 8, 9, 12, 13, 14, 15, 17, 18], "default": [1, 3, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19], "default_channel": [4, 17], "defin": [0, 1, 2, 3, 6, 9, 10, 12, 15, 18], "define_env_var": 3, "definit": [2, 4, 9, 12], "delet": 4, "deliveri": 0, "delivery_dashboard_url": [9, 15], "demo_break": 10, "depend": [1, 2, 3, 4], "dependency_nam": 18, "dependency_typ": 18, "dependency_vers": 18, "dependend": 3, "deprec": [17, 18], "deriv": 12, "describ": [3, 18], "descript": [4, 15, 18], "descriptor": [2, 9, 12, 14, 15, 18], "detail": 12, "detect": 18, "determin": [2, 3, 6], "dev": 18, "dev_cycle_callback": 14, "develop": [4, 14], "dict": [2, 3, 6, 7, 12, 15, 17, 18], "dictionari": 3, "diff": 14, "differ": [0, 1, 2, 6, 9, 12, 15], "dir": 12, "directori": [3, 12], "disabl": [1, 2, 13, 14], "disable_ci_skip": 2, "discov": [14, 18], "displai": [1, 6], "do": [2, 4, 14], "doc": 4, "docker": 12, "dockerd": 12, "dockerfil": 12, "document": [1, 3, 6, 9, 12], "doe": [0, 2], "don": 6, "done": [0, 2, 3, 6, 12, 14, 18, 19], "down": 6, "draft": 8, "draft_releas": [4, 5], "drop": 6, "dry_run": 6, "dso": 15, "dure": [3, 6, 14, 19], "e": [2, 3, 4, 6, 7, 9, 14, 15, 18], "each": [0, 1, 2, 3, 6, 12, 18], "easier": 4, "easili": 4, "edit": 4, "effect": [2, 6, 7, 8, 12, 14, 19], "effective_vers": [12, 14, 19], "effort": 6, "either": [2, 6, 15], "element": [1, 2, 4, 6], "els": 6, "email": [9, 10, 15], "email_address": 10, "email_recipi": [9, 15], "empti": 1, "enabl": [4, 15], "encompass": 0, "end": [7, 14], "enforc": 14, "enrich": 14, "entri": [6, 12], "enum": 15, "env": [2, 3, 18], "env_var_nam": 3, "environ": [0, 3, 10, 12, 14, 19], "equal": 18, "error": [10, 14, 18], "escap": 3, "escape_argv": 3, "establish": 4, "etc": [9, 15], "eu": [6, 12], "europ": 7, "evalu": [2, 3, 6], "even": 4, "everi": [4, 7, 10], "everyth": 15, "exactli": [3, 6], "exampl": [4, 15], "example_slack_workspac": 4, "exce": 15, "excecut": 12, "except": [12, 15], "exclud": [2, 15], "exclude_path": 15, "exclude_path_regex": 15, "excplicitli": 15, "execut": [0, 2, 3, 6, 7, 12, 13, 16, 18, 19], "executable_with_arg": 3, "executor": 0, "exempt": 6, "exist": [0, 1, 6, 10, 14], "exit": [3, 14, 18], "expans": 3, "expect": [3, 6, 12], "experiment": 3, "explain": 4, "explan": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "explicitli": [2, 6, 12], "expos": [3, 6, 13], "express": [1, 3], "extend": [6, 18], "extens": 1, "extern": 6, "extra_push_target": 12, "extract": 4, "fail": [3, 9, 10, 14, 15], "failur": [3, 14], "fals": [2, 3, 6, 7, 9, 11, 12, 14, 15, 19], "featur": [4, 6], "fetch": [4, 6], "file": [1, 3, 6, 9, 10, 12, 14, 15, 19], "filter": 1, "final": [6, 8, 14, 18, 19], "finish": 3, "first": [4, 6, 10, 14], "first_imag": 12, "first_step": 3, "flag": [1, 4, 6], "follow": [2, 4, 6, 8, 9, 12, 14, 15, 18], "foo": [2, 3, 10], "forbidden": 2, "forc": [2, 3, 12], "force_push": [2, 3], "foremostli": 6, "forget": 6, "form": [3, 7], "format": [6, 7, 9, 15], "found": [1, 6, 9, 15], "fr": 7, "fragment": 1, "frequent": 6, "fridai": 7, "from": [0, 1, 3, 4, 6, 9, 12, 14, 15, 18, 19], "full": [6, 13], "further": 6, "futur": [1, 12], "g": [2, 3, 4, 6, 7, 9, 14, 15, 18], "garden": [0, 1, 2, 4, 6, 12, 15, 18, 19], "gardenlet": 6, "gather": 4, "gcr": [6, 12], "gener": [0, 1, 4, 6, 9, 18], "get": 3, "git": [2, 6], "git_tag": 14, "github": [1, 4, 6, 9, 13, 14, 15, 18], "github_cfg": 2, "github_com": 2, "github_issu": [9, 15], "github_issue_labels_to_preserv": [9, 15], "github_issue_templ": [9, 15], "github_path": 2, "github_wdf_sap_corp": 2, "githubissuetemplatecfg": [9, 15], "given": [2, 3, 6, 12], "glob": 2, "global": 1, "go": [3, 7, 9], "graph": [0, 3], "grc": 12, "great": 18, "greatest": 6, "greatest_cv": [9, 15], "group": [4, 6], "guarante": 12, "guess": 6, "h": [6, 7], "ha": [1, 2, 3, 4, 6, 7, 10, 11, 13, 16, 17, 19], "hack": 15, "handl": [14, 19], "hard": 6, "hash": 19, "have": [3, 4, 6, 9, 13], "head": [1, 2, 4, 6, 7, 14, 19], "header": 6, "helm": 6, "helmchart": 12, "helmchartcfg": 12, "help": [4, 6], "here": [4, 6, 19], "heurist": 6, "hh": 7, "high": [9, 15], "hint": [9, 15], "hold": [4, 12], "honour": 12, "host": [2, 19], "hostnam": 2, "how": [6, 14, 19], "howev": [0, 6], "http": [2, 4], "i": [0, 1, 2, 3, 4, 6, 7, 9, 12, 13, 14, 15, 18, 19], "id": [4, 15], "ideal": 4, "identifi": [2, 6, 9, 18], "iff": [1, 18], "ignor": [2, 6, 7, 12, 14, 18], "ignore_prerelease_vers": 18, "imag": [0, 3, 9, 12, 14, 18], "image_refer": [6, 14, 18], "image_scan": 5, "imagerefer": 6, "immedi": [6, 14, 18], "implement": [6, 12, 18], "impli": [2, 19], "implicitli": 6, "improv": 4, "includ": [2, 4, 6, 9, 12, 15], "include_path": 15, "include_path_regex": 15, "increment": 14, "index": [0, 5], "indic": [6, 12, 18], "influenc": 6, "info": 15, "inform": [4, 13], "infrastructur": 6, "inherit": 4, "inherit_m": 1, "initi": 3, "inject": [6, 19], "inject_effective_vers": 19, "inlin": 6, "input": [2, 3, 6, 10], "input_nam": 3, "insan": 18, "insid": [3, 6, 14], "instal": 6, "instanc": [2, 3], "instanti": 1, "instead": [0, 6], "instrument": 6, "int": [9, 11, 15], "integ": 3, "intend": [6, 18], "interact": 0, "intern": 6, "interpret": [3, 7, 12], "interrupt": [3, 9], "interv": [3, 7, 9], "introduc": 4, "invalid": 18, "invers": 2, "invok": 18, "io": [6, 12], "issu": [9, 10, 15], "issue_polici": [9, 15], "issuepolici": [9, 15], "its": [2, 6], "itself": 2, "job": [0, 3, 4, 6, 7, 8, 9, 12, 13, 14, 16, 18, 19], "job_a": 1, "job_b": 1, "just": [3, 4], "kebap": 2, "keep": [1, 6], "kei": 4, "kernel": 12, "know": 4, "known": 4, "kubernet": [2, 4], "label": [2, 6, 9, 12], "landscap": 6, "last": [4, 10], "later": [9, 18], "latest": [12, 14, 18], "latter": 6, "layer": 9, "layout": 6, "lead": [6, 14], "least": [1, 12, 14], "leav": 6, "left": 14, "legaci": 6, "level": 1, "like": [3, 4, 6, 18], "limit": [6, 7], "linux": 12, "list": [1, 2, 3, 6, 7, 9, 10, 12, 13, 14, 15, 17, 18], "littl": 6, "local_dependency_nam": 18, "locat": 6, "log": 11, "logic": [2, 3, 9, 12, 18], "look": [1, 4], "lookup": 6, "low": [9, 15], "m": 7, "made": [2, 10, 12, 19], "mai": [0, 1, 2, 3, 6, 9, 10, 12, 18], "mail": 10, "main": [3, 7, 10, 12, 13, 14, 19], "main_repo": [3, 18], "main_repo_dir": 2, "main_repositori": 18, "major": 14, "make": [4, 6, 13], "malici": 13, "mandatori": 1, "mani": 6, "manual": [6, 14, 18], "map": [3, 6], "mark": 9, "master": [1, 2], "match": [1, 6, 9, 15], "matching_config": 9, "materi": 6, "max_processing_time_dai": [9, 15], "maximum": [3, 9, 15], "maxmimum": 9, "me": 6, "mean": [9, 13], "mechan": [4, 6], "medium": [9, 15], "mention": 9, "merg": [4, 14, 18], "merge_release_to_default_branch_commit_message_prefix": 14, "mergepolici": 18, "mergepolicyconfig": 18, "messag": [4, 14], "meta": [1, 6], "might": [3, 6], "mind": 6, "minor": [6, 14], "minut": 7, "mitig": 13, "mm": 7, "mnt": 18, "mo": 7, "mode": [3, 6], "model": 14, "modifi": 18, "mondai": 7, "more": [10, 13], "most": [3, 4, 6, 9, 10], "mostli": 6, "mount": 18, "msg": 2, "multi": [6, 12], "multiarch": 12, "multipl": [6, 12], "multistag": 12, "must": [2, 3, 6, 10, 12, 15, 18, 19], "my": 4, "my_important_valu": 3, "my_pipelin": 1, "my_repo": [2, 3], "my_repo_path": 2, "my_script": 3, "my_slack_channel": 17, "my_slack_channel_nam": 4, "mycloud": 10, "name": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "namespac": 1, "narrow": 6, "nativ": 0, "necessarili": 6, "need": [4, 6, 13], "never": [9, 10, 15], "new": 4, "newer": 18, "next": [4, 14], "next_version_callback": 14, "next_version_commit_message_prefix": 14, "nextvers": [1, 4], "nobodi": [9, 15], "node": 12, "non": [1, 2, 3, 14], "none": [2, 3, 4, 6, 7, 9, 12, 14, 15, 16, 17, 18, 19], "noop": [14, 19], "notabl": [4, 12], "note": [8, 14, 17], "noteworthi": 4, "notif": [3, 5], "notifi": 10, "notificationrecipi": 10, "notifications_cfg": 3, "notificationtriggeringpolici": 10, "notifii": 10, "notify_cfg_out": 10, "now": 4, "null": 12, "number": 13, "o": 6, "obsolet": 6, "obviou": 13, "occur": [11, 14], "occurr": 2, "oci": [6, 9, 14, 18], "ocibuild": 12, "ociimag": 6, "ociregistri": 6, "ocm": 6, "ocm_repo_url": 6, "ocm_repositori": 6, "ocm_repository_map": 6, "ocmrepositorymappingentri": 6, "offer": [0, 6, 18], "ok": 13, "omit": [1, 2], "on_abort": 3, "on_error_dir": 10, "onc": [4, 6], "one": [1, 3, 12, 14, 18], "ones": 18, "onli": [1, 2, 3, 4, 6, 10, 12, 13, 15, 18, 19], "onlin": 6, "only_first": 10, "open": 4, "oper": [0, 4, 8, 9, 14, 19], "opinion": 6, "option": [1, 2, 3, 4, 5, 6, 9, 10, 12, 15], "order": [0, 4, 6, 12], "org": 6, "organis": 1, "origin": 6, "other": [2, 3, 4, 6, 12, 18], "otherwis": [1, 2, 9, 12], "ought": 2, "our": [0, 4], "out": [3, 6, 15], "out_path": 3, "outdat": 18, "output": [3, 6, 12, 18], "output_dir": [3, 12], "output_nam": 3, "over": [4, 6, 12], "overwrit": [2, 6, 9, 15], "overwrite_github_issues_tgt_repository_url": [9, 15], "overwritten": [6, 9], "own": [1, 6], "packag": 6, "pair": 3, "parallel": [3, 9, 16], "parallel_job": 9, "part": 6, "pass": [3, 12, 14], "patch": 14, "patchlevel": 14, "path": [2, 3, 6, 10, 12, 14, 18, 19], "path_config": 15, "payload": 3, "per": 3, "perform": [6, 9, 14, 15], "period": [6, 7], "persist": 14, "pgk": 15, "phase": 6, "pip3": 6, "pipelin": [4, 6, 19], "pipeline_definit": [0, 6], "pipeline_descriptor": 3, "pipeline_model": 3, "pkg": 15, "place": [1, 3, 6, 12], "placehold": 14, "platform": 12, "polici": [3, 9, 10, 14, 15, 18], "posit": [3, 9], "possibl": [2, 4, 6, 10], "post": [13, 14], "potenti": 3, "ppc64le": 12, "pr": [13, 18], "pre": 6, "prebuild_hook": 12, "predefin": 6, "prefer": [2, 4, 6], "prefix": [6, 14], "prepar": 12, "preprocess": [8, 12, 14], "prereleas": 18, "prerequisit": 12, "presenc": [2, 7], "present": [1, 2, 6, 9, 12, 14, 15], "prevent": 16, "previou": 14, "principl": 0, "prior": [6, 12], "privat": 2, "privileg": 3, "privilegemod": 3, "process": [6, 8, 9, 13, 15], "produc": [3, 6], "productutil": 6, "progress": 6, "project": [0, 6, 12], "promin": 10, "propos": 4, "protocol": 2, "provid": [2, 6], "public_build_log": 11, "publish": [0, 3, 5, 6, 14, 17], "publish_commit": 3, "publish_to": 3, "pull": [2, 5, 6, 18], "pullrequest_id": 13, "pullrequest_url": 13, "push": [2, 3, 4, 12, 14], "push_to_branch": 14, "put": 4, "pwd": 3, "py": 6, "python": [3, 6], "python3": [6, 9, 15, 18], "pythonpath": 18, "quemu": 12, "question": 6, "rang": 7, "re": [1, 6], "react": [2, 13], "read": [2, 19], "read_callback": 19, "reason": [1, 6, 13, 18, 19], "rebas": 14, "rebase_before_releas": 14, "receiv": [12, 18], "recipi": [9, 15], "recommend": [14, 18], "recurs": 6, "reduc": 12, "ref": [1, 6, 14], "ref_templ": 14, "refer": [1, 2, 3, 6, 12, 14, 18], "referenc": [2, 6, 12], "refrain": 1, "regex": [9, 15], "registri": [3, 6, 12], "regular": [1, 6, 19], "reject": 18, "rel": [2, 3, 7, 10, 12, 14, 19], "relat": 6, "relax": 6, "releas": [2, 5, 6, 8, 12, 17, 18], "release_callback": 14, "release_on_github": 14, "releasecommitpublishingpolici": 14, "releasenotespolici": 14, "relev": [4, 6, 14], "remot": 4, "remov": [3, 6, 9, 13, 15, 18, 19], "render": 1, "render_pipelin": 1, "repeat": 13, "replac": [6, 13], "replic": 3, "repo": [2, 6, 12, 18, 19], "repo_dir": [14, 18], "repo_path": 2, "repo_root": 10, "report": 13, "report_url": [9, 15], "repositori": [1, 3, 4, 6, 7, 9, 10, 12, 13, 14, 15, 17, 18, 19], "request": [2, 5, 6, 18], "requir": [0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "rescan": 9, "rescor": 9, "resid": [1, 2], "resolv": 6, "resolve_depend": 6, "resourc": [6, 9, 12, 15], "resource_label": 12, "resource_nam": [9, 15], "resource_typ": [9, 15], "resource_vers": [9, 15], "restrict": [2, 6], "result": [0, 1, 3, 6, 9, 10, 12, 13, 14, 15], "retain": 11, "retention_polici": 6, "retentions_polici": 6, "retri": 3, "retriev": [3, 6, 9], "return": [18, 19], "reus": 4, "review": 13, "riscv64": 12, "risk": 13, "root": [1, 2, 6, 10, 12, 14], "rotat": 11, "rule": 6, "run": [0, 2, 3, 6, 7, 9, 12, 14], "runtim": [6, 13, 18], "s3": 9, "s390x": 12, "said": [6, 13, 14], "same": [1, 2, 3, 6, 12, 16], "sane": 18, "saturdai": 7, "save": 14, "scalar": 3, "scan": [1, 9, 15], "scan_sourc": 5, "scan_timeout": 15, "scenario": 1, "schedul": [0, 5], "scheme": 6, "scp_workspac": 17, "script": [6, 18], "search": 1, "second": [3, 4, 15], "second_imag": 12, "section": 4, "secur": 13, "see": [1, 3, 4, 6, 9, 10, 12, 14, 17], "self": 0, "semant": [0, 1, 14, 18], "semver": [6, 18, 19], "send": 10, "separ": 18, "server": 2, "servic": 0, "set": [0, 2, 3, 7, 8, 9, 12, 13, 14, 15, 18, 19], "set_dependency_vers": 18, "set_dependency_version_script": 18, "severity_threshold": 15, "shall": 13, "share": [1, 6, 12], "shell": [3, 6], "short": [1, 6], "shorten": 14, "shortliv": 6, "should": [1, 2, 3, 4, 6, 12, 14, 15, 16, 18], "shown": 4, "signal": 18, "similar": [6, 18], "simpli": 6, "sinc": 4, "singl": [7, 12], "skip": [2, 15], "sla": [9, 15], "slack": [5, 14], "slack_cfg_nam": [4, 17], "smallest": 6, "snake": 2, "snake_cas": 3, "snapshot": 6, "so": [1, 4], "some": [0, 3, 6], "someon": 6, "sourc": [0, 1, 2, 3, 4, 6, 12, 15, 19], "source_analysi": 15, "source_branch": 2, "source_github_repo_owner_and_nam": 2, "source_label": 2, "source_path": 2, "sourcerepositori": 6, "special": 1, "specif": [2, 6, 10, 14, 18], "specifi": [2, 3, 4, 6, 7, 9, 12, 14, 15, 18], "src": 15, "ssh": 2, "stale": 6, "standardis": [0, 6], "start": [4, 6, 7, 13], "static": 12, "statu": 13, "stdin": 19, "stdout": 19, "step": [0, 1, 2, 4, 6, 9, 10, 13, 14, 18], "step_nam": 3, "stepinput": 6, "still": 4, "store": [2, 6], "str": [2, 3, 6, 7, 8, 9, 10, 12, 13, 14, 15, 17, 18, 19], "strictly_follow": 18, "string": [6, 7], "strongli": 14, "style": [3, 7, 9], "sub": [9, 15], "subject": [6, 9], "submodul": 2, "submodule_cfg_nam": 2, "subprocess": [10, 14], "subsequ": [3, 8, 13], "subset": 12, "succeed": 3, "success": 3, "successor": 6, "suffix": [7, 12, 19], "summari": [9, 15], "sundai": 7, "support": [2, 4, 6, 7, 12], "suppress_parallel_execut": 16, "sure": 1, "symbol": 3, "syntax": [2, 9, 15], "system": [6, 9], "t": 6, "tabl": [9, 15], "tag": [4, 6, 12, 14], "tag_and_merge_back": 14, "tag_as_latest": 12, "tag_onli": 14, "tag_templ": 12, "tagconflictact": 14, "tailor": 6, "take": 14, "target": [4, 9, 12, 15, 18], "target_group": 4, "targetspec": 12, "tbd": 15, "team": [1, 15], "team_id": 15, "technologi": 0, "tell": 6, "templat": [1, 4, 6, 9, 12, 15], "termin": 6, "test": [0, 13, 15], "text": 4, "than": 18, "thei": [2, 6, 12], "them": [3, 13, 14], "themselv": 3, "therefor": [2, 6, 18], "thi": [1, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "thing": 6, "those": [2, 6, 9, 12, 13], "threshold": 15, "through": [0, 3], "thu": [4, 6, 12, 13, 14], "thursdai": 7, "ticket": [9, 15], "time": [3, 6, 7, 9, 12, 14, 15], "timeout": [3, 9, 15], "timerang": 7, "timezon": 7, "tool": [6, 9, 14, 18], "toolchain": 6, "top": 1, "toplevel": 12, "touch": 2, "toward": [3, 6], "trait": [0, 1, 2, 3, 4], "trait_depend": [3, 9], "tree": [1, 2, 3, 6, 12, 14, 18, 19], "tri": 6, "trigger": [7, 9, 10, 13, 14, 15], "true": [1, 2, 3, 6, 10, 12, 14, 15, 16, 18], "try": 1, "tuesdai": 7, "turn": 13, "two": [1, 3, 4, 7, 12], "type": [2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "typic": [0, 6], "ui": 1, "unauthent": 11, "unchang": 3, "undefin": [2, 18], "underli": [0, 6, 12], "underscor": 2, "uniqu": 3, "unknown": 18, "unless": 9, "unprivileg": 3, "unresolv": 6, "until": 3, "untrust": 3, "up": [1, 12], "updat": [2, 4, 6, 7, 8, 9, 13, 14, 15, 18], "update_component_dep": 5, "uploadmod": 6, "upon": [4, 9, 10, 13, 15, 17, 18], "upper": [2, 3], "upper_cas": 3, "upstream": 18, "upstream_component_nam": 18, "upstream_update_polici": 18, "url": [6, 13], "us": [0, 1, 2, 3, 4, 7, 9, 10, 12, 14, 15, 17, 18, 19], "usag": [1, 2], "user": [1, 2, 4, 11], "usual": 4, "util": [6, 18], "v1": 15, "v2": 6, "v6": 12, "v7": 12, "valid": [1, 2, 6, 19], "validation_polici": 6, "valu": [1, 4], "var": [3, 18], "variabl": [3, 9, 10, 12, 14, 15, 19], "variant": [9, 12], "varieti": 0, "verbatim": 3, "veri": 4, "version": [4, 5, 8, 9, 12, 14, 15, 18], "version_path": 19, "versionfil": 19, "versioninterfac": 19, "versionretentionpolici": 6, "very_high_or_great": [9, 15], "via": [3, 6, 14, 18, 19], "view": 4, "virtualis": 14, "viru": 9, "virus_db_max_age_dai": 9, "vpn": 6, "w": 6, "wa": [2, 4, 6, 13], "wai": [6, 18], "we": [0, 4], "web": 18, "wednesdai": 7, "weekdai": 7, "well": [0, 3], "were": 18, "when": [1, 3, 4, 6, 9, 10, 12, 14, 15], "whera": 3, "where": [4, 6], "wherea": 13, "whether": [2, 3, 6, 10, 11, 12, 14, 15, 16, 18, 19], "which": [0, 2, 3, 4, 6, 7, 9, 12, 13, 14, 15], "while": 14, "whitespac": [1, 3], "whole": 15, "whom": [9, 10, 15], "within": [0, 1, 4, 6, 12, 18], "without": [0, 3, 12], "word": 2, "work": [2, 3, 6, 12, 14, 18], "worker": 9, "working_dai": 7, "working_hour": 7, "workload": 0, "workspac": 4, "worktre": [1, 3, 14], "would": [1, 4], "writabl": 3, "write": [4, 10, 19], "write_callback": 19, "writeabl": 18, "written": 19, "x86_64": 12, "yaml": 1, "ye": [9, 12, 14, 15, 17, 18], "yet": 6, "you": [4, 6], "your": [3, 4, 15], "zero": [3, 14, 18]}, "titles": ["CC-Utils - Build Pipeline Reference Manual", "Pipeline Definition", "Pipeline Job", "Pipeline Steps", "Release Notes Process", "Pipeline Definition Traits", "component_descriptor Trait", "cronjob Trait", "draft_release Trait", "image_scan Trait", "notifications Trait", "options Trait", "publish Trait", "pull-request Trait", "release Trait", "scan_sources Trait", "scheduling Trait", "slack Trait", "update_component_deps Trait", "version Trait"], "titleterms": {"To": 4, "add": 6, "addit": [2, 6], "aka": 6, "attribut": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "base_definit": 1, "behaviour": [2, 18], "branch": 1, "build": [0, 12], "builder": 12, "callback": 14, "case": 6, "categori": 4, "cc": 0, "cfg_name": 2, "chart": 6, "checkmarx": 15, "checkmarxcfg": 15, "chosen": 12, "ci": 1, "clam_av": 9, "clamavscancfg": 9, "clean": 6, "cleanup": 6, "cli": 6, "command": 6, "commit": 4, "compon": [6, 18], "component_descriptor": 6, "concept": 0, "configur": 1, "contract": [6, 14, 18], "contribut": 4, "cronjob": 7, "cycl": 14, "declar": 6, "default": [2, 6, 10], "definit": [0, 1, 5], "depend": [6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "deprec": 6, "descriptor": 6, "dev": 14, "develop": 6, "dockerimag": 12, "draft": 4, "draft_releas": 8, "enumer": [2, 3, 6, 9, 10, 12, 14, 15, 18, 19], "environ": [2, 6, 18], "exampl": [1, 2, 3, 6, 7, 10, 12, 13, 14, 16, 17], "extens": 18, "filter": 15, "filtercfg": 15, "format": 4, "from": 2, "github": 2, "handl": [6, 13], "hotfix": 1, "how": 4, "imag": 6, "image_scan": 9, "imagevector": 6, "implicitli": 12, "indic": [0, 5], "inherit": 1, "inject": 12, "input": 12, "introduct": 0, "job": [1, 2], "label": [13, 15], "local": 6, "main": 2, "manual": 0, "map": 4, "merge_polici": 18, "nextvers": 14, "note": [4, 18], "notif": 10, "notifi": [9, 15], "notificationcfg": 10, "notificationcfgset": 10, "oci": 12, "ociimagecfg": [14, 18], "old": 6, "on_error": 10, "on_tag_conflict": 14, "option": [11, 14], "os_id": 9, "osidscan": 9, "pass": [6, 18], "path": 15, "pipelin": [0, 1, 2, 3, 5], "pipeline_definit": 1, "polici": [6, 13], "post": 4, "preferred_protocol": 2, "preliminari": 6, "preprocess": 19, "privilege_mod": 3, "process": 4, "protecod": 15, "publish": 12, "publishdockerimagedescriptor": 12, "pull": [4, 13], "pullrequestpolici": 13, "recipi": 10, "refer": 0, "releas": [1, 4, 14], "release_callback_image_refer": 14, "release_commit_publishing_polici": 14, "release_notes_polici": 14, "render": 6, "repositori": 2, "request": [4, 13], "retent": 6, "scan_sourc": 15, "schedul": 16, "schema": 1, "schemat": 1, "semant": [6, 15], "set": 6, "set_dependency_version_script_container_imag": 18, "slack": [4, 17], "special": 6, "specif": 1, "step": [3, 12], "support": 15, "tabl": [0, 5], "term": 0, "titl": 4, "trait": [5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19], "transport": 4, "trigger": 2, "trigger_path": 2, "triggering_polici": 10, "up": 6, "update_component_dep": 18, "upgrad": 18, "upload": 6, "us": 6, "user": 12, "util": 0, "valu": [2, 3, 6, 9, 10, 12, 14, 15, 18, 19], "variabl": [2, 6, 18], "version": [6, 19], "version_interfac": 19, "yaml": 6}}) \ No newline at end of file diff --git a/traits/draft_release.html b/traits/draft_release.html index beca9d681..30ffc7a68 100644 --- a/traits/draft_release.html +++ b/traits/draft_release.html @@ -120,8 +120,8 @@

draft_release Trait

This trait requires the following traits to be declared:

Declaring jobs will create or update draft-release-notes that will automatically be collected for diff --git a/traits/release.html b/traits/release.html index 60aea415e..bf7fda500 100644 --- a/traits/release.html +++ b/traits/release.html @@ -309,8 +309,8 @@

on_tag_conflict Enumeration Values

This trait requires the following traits to be declared:

This trait add release job semantics to the declaring build job.