Commit 88eb63d5 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

fix(sbom): only generate SBOMs on prod branches, integ branches and release tags

parent a91e9e15

README.md

+1 −0
Original line number Diff line number Diff line
@@ -228,6 +228,7 @@ It is bound to the `test` stage, and uses the following variables: 
| Input / Variable | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `sbom-disabled` / `MAVEN_SBOM_DISABLED` | Set to `true` to disable this job | _none_ |

| `TBC_SBOM_MODE`                      | Controls when SBOM reports are generated (`onrelease`: only on `$INTEG_REF`, `$PROD_REF` and `$RELEASE_REF` pipelines; `always`: any pipeline).<br/>:warning: `sbom-disabled` / `DOCKER_SBOM_DISABLED` takes precedence | `onrelease` |

| `sbom-gen-args` / `MAVEN_SBOM_GEN_ARGS` | Maven command used for SBOM analysis | `org.cyclonedx:cyclonedx-maven-plugin:makeAggregateBom` |



### `mvn-release` &amp; `mvn-deploy-*` jobs

kicker.json

+8 −0
Original line number Diff line number Diff line
@@ -115,6 +115,14 @@ 
      "description": "This job generates a file listing all dependencies using [cyclonedx-maven-plugin](https://github.com/CycloneDX/cyclonedx-maven-plugin)",

      "disable_with": "MAVEN_SBOM_DISABLED",

      "variables": [

        {

          "name": "TBC_SBOM_MODE",

          "type": "enum",

          "values": ["onrelease", "always"],

          "description": "Controls when SBOM reports are generated (`onrelease`: only on `$INTEG_REF`, `$PROD_REF` and `$RELEASE_REF` pipelines; `always`: any pipeline)",

          "advanced": true,

          "default": "onrelease"

        },

        {

          "name": "MAVEN_SBOM_GEN_ARGS",

          "description": "Maven command used for SBOM analysis",

templates/gitlab-ci-maven.yml

+18 −1
Original line number Diff line number Diff line
@@ -173,7 +173,18 @@ workflow: 
    # else (Ready MR): auto & failing

    - when: on_success



# software delivery job prototype: run on production and integration branches + release pipelines

.delivery-policy:

  rules:

    # on tag with release pattern

    - if: '$CI_COMMIT_TAG =~ $RELEASE_REF'

    # on production or integration branch(es)

    - if: '$CI_COMMIT_REF_NAME =~ $PROD_REF || $CI_COMMIT_REF_NAME =~ $INTEG_REF'



variables:

  # Global TBC SBOM Mode (onrelease -> only generate SBOMs for releases, always -> generate SBOMs for all refs)

  TBC_SBOM_MODE: "onrelease"



  # Default Maven project root directory

  MAVEN_PROJECT_DIR: $[[ inputs.project-dir ]]

  # Maven image (can be overridden)
@@ -735,7 +746,13 @@ mvn-sbom: 
    # exclude if disabled

    - if: '$MAVEN_SBOM_DISABLED == "true"'

      when: never

    - !reference [.test-policy, rules]

    # 'always' mode: run

    - if: '$TBC_SBOM_MODE == "always"'

    # exclude unsupported modes

    - if: '$TBC_SBOM_MODE != "onrelease"'

      when: never

    # 'onrelease' mode: use common software delivery rules

    - !reference [.delivery-policy, rules]



mvn-deploy-snapshot:

  extends: .mvn-base