template the workflow

camunda · Jan 20, 2025 · e97beb6 · e97beb6
1 parent 24c3736
commit e97beb6
Show file tree

Hide file tree

Showing 4 changed files with 157 additions and 100 deletions.
diff --git a/.github/actions/generate-versions-matrix/action.yml b/.github/actions/generate-versions-matrix/action.yml
@@ -7,6 +7,8 @@ inputs:
     required: true
 
 outputs:
+  # NOTE: The logic is reversed here (get unchanged files instead of the changed ones),
+  # to avoid creating GHA skipped jobs. This twist is due to how GHA works.
   unchanged:
     description: JSON matrix of unchanged versions which will be used as and input for GHA workflow matrix exclude.
     value: ${{ steps.get-versions.outputs.matrix-unchanged }}

diff --git a/.github/workflows/docker-compose-release-template.yaml b/.github/workflows/docker-compose-release-template.yaml
@@ -0,0 +1,107 @@
+# NOTE: Camunda Docker Compose release is a rolling release.
+# So it's always 1 artifact per Camunda minor version.
+name: "Docker Compose | Release - Template"
+
+on:
+  workflow_call:
+    inputs:
+      camunda-version:
+        description: Camunda minor version in format x.y, alpha, or wildcard.
+        required: true
+        type: string
+      git-ref:
+        description: Git ref that will be used to release.
+        default: refs/heads/main
+        type: string
+
+env:
+  GIT_REF: ${{ inputs.git-ref }}
+  DOCKER_COMPOSE_NAME: docker-compose-${{ inputs.camunda-version }}
+  DOCKER_COMPOSE_WORKING_DIRECTORY: docker-compose/versions/camunda-${{ inputs.camunda-version }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      #
+      # Init.
+      - name: ℹ️ Print workflow inputs ℹ️
+        env:
+          GITHUB_CONTEXT: ${{ toJson(inputs) }}
+        run: |
+          echo "Workflow Inputs:"
+          echo "${GITHUB_CONTEXT}"
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+        with:
+          ref: ${{ inputs.git-ref }}
+
+      #
+      # Artifacts.
+      - name: Create release artifact
+        run: |
+          tar -czf ${{ env.DOCKER_COMPOSE_NAME }}.tgz \
+            -C ${{ env.DOCKER_COMPOSE_WORKING_DIRECTORY }} .
+
+      #
+      # Security signature.
+      - name: Install Cosign CLI
+        uses: sigstore/cosign-installer@4959ce089c160fddf62f7b42464195ba1a56d382 # v3.6.0
+      - name: Sign Helm chart with Cosign
+        run: |
+          cosign sign-blob -y ${{ env.DOCKER_COMPOSE_NAME }}.tgz \
+            --bundle ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle
+      - name: Verify signed Helm chart with Cosign
+        run: |
+          cosign verify-blob ${{ env.DOCKER_COMPOSE_NAME }}.tgz \
+            --bundle ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle \
+            --certificate-identity "https://github.com/${{ github.repository }}/.github/workflows/docker-compose-release-template.yaml@${{ github.ref }}" \
+            --certificate-oidc-issuer "https://token.actions.githubusercontent.com"
+
+      #
+      # Release
+      # TODO: Use gomplate to generate the Docker Compose release notes.
+      - name: Create release notes
+        run: |
+          grep _VERSION ${{ env.DOCKER_COMPOSE_WORKING_DIRECTORY }}/.env > VERSIONS.txt
+          cat << EOF > RELEASE-NOTES.md
+          $(cat ${{ env.DOCKER_COMPOSE_WORKING_DIRECTORY }}/README.md) 
+          ## Versions
+          $(printf -- "- %s\n" $(cat VERSIONS.txt))
+          ## Verification
+          To verify the integrity of the artifact using [Cosign](https://docs.sigstore.dev/signing/quickstart/):
+          \`\`\`shell
+          # Download Docker Compose artifact.
+          curl -LO https://github.com/${{ github.repository }}/releases/download/${{ env.DOCKER_COMPOSE_NAME }}/${{ env.DOCKER_COMPOSE_NAME }}.tgz
+          # Download Docker Compose Cosign bundle.
+          curl -LO https://github.com/${{ github.repository }}/releases/download/${{ env.DOCKER_COMPOSE_NAME }}/${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle
+          # Verify with cosign.
+          cosign verify-blob ${{ env.DOCKER_COMPOSE_NAME }}.tgz \\
+            --bundle ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle \\
+            --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \\
+            --certificate-identity "https://github.com/${{ github.repository }}/.github/workflows/docker-compose-release-template.yaml@${{ github.ref }}"
+          \`\`\`
+          ## Notes
+          - **Release strategy:** Camunda Docker Compose release is a rolling release. Hence, it's always 1 artifact per Camunda minor version.
+          - **Latest update:** $(date)
+          EOF
+      - name: Create git tag
+        run: |
+          git tag ${{ env.DOCKER_COMPOSE_NAME }}
+      - name: Release on GitHub
+        id: gh-release
+        uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2
+        with:
+          name: ${{ env.DOCKER_COMPOSE_NAME }}
+          tag_name: ${{ env.DOCKER_COMPOSE_NAME }}
+          body_path: RELEASE-NOTES.md
+          files: |
+            ${{ env.DOCKER_COMPOSE_NAME }}.tgz
+            ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle
+      - name: Add release URL to workflow summary
+        run: |
+          echo "⭐ Release URL: ${{steps.gh-release.outputs.url}}" >> $GITHUB_STEP_SUMMARY
diff --git a/.github/workflows/docker-compose-release.yaml b/.github/workflows/docker-compose-release.yaml
@@ -3,110 +3,57 @@
 name: "Docker Compose | Release"
 
 on:
-  workflow_dispatch:
-    inputs:
-      camunda-version:
-        description: Camunda minor version in format x.y
-        required: true
-        type: string
-      release-tag:
-        description: |
-          The tag name of the released Docker Compose.
-          By Default, it will use the platform version.
-        type: string
-      git-ref:
-        description: Git ref that will be used to release.
-        default: main
-        type: string
+  push:
+    branches:
+      - main
+      - docker-compose-distro-287-gha-release-workflow
+    paths:
+      - docker-compose/versions/**
+      - .github/workflows/docker-compose-release.yaml
+  pull_request:
+    paths:
+      - .github/workflows/docker-compose-release-template.yaml
+      - .github/workflows/docker-compose-release.yaml
+      - docker-compose/versions/**
 
-env:
-  GIT_REF: ${{ inputs.git-ref }}
-  DOCKER_COMPOSE_NAME: docker-compose-${{ inputs.camunda-version }}
-  DOCKER_COMPOSE_WORKING_DIRECTORY: docker-compose/versions/camunda-${{ inputs.camunda-version }}
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref_name }}
+  cancel-in-progress: true
 
 jobs:
-  release:
-    name: Release
+  init:
+    name: Generate version matrix
     runs-on: ubuntu-latest
-    permissions:
-      id-token: write
-      contents: write
     steps:
-      #
-      # Init.
-      - name: ℹ️ Print workflow inputs ℹ️
-        env:
-          GITHUB_CONTEXT: ${{ toJson(inputs) }}
-        run: |
-          echo "Workflow Inputs:"
-          echo "${GITHUB_CONTEXT}"
-      - name: Checkout
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+      - name: Generate versions
+        id: generate-versions-matrix
+        uses: ./.github/actions/generate-versions-matrix
         with:
-          ref: ${{ inputs.git-ref }}
+          versions-path: "docker-compose/versions/camunda-*"
+    outputs:
+      unchanged-versions: ${{ steps.generate-versions-matrix.outputs.unchanged }}
 
-      #
-      # Artifacts.
-      - name: Create release artifact
-        run: |
-          tar -czf ${{ env.DOCKER_COMPOSE_NAME }}.tgz \
-            -C ${{ env.DOCKER_COMPOSE_WORKING_DIRECTORY }} .
-
-      #
-      # Security signature.
-      - name: Install Cosign CLI
-        uses: sigstore/cosign-installer@4959ce089c160fddf62f7b42464195ba1a56d382 # v3.6.0
-      - name: Sign Helm chart with Cosign
-        run: |
-          cosign sign-blob -y ${{ env.DOCKER_COMPOSE_NAME }}.tgz \
-            --bundle ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle
-      - name: Verify signed Helm chart with Cosign
-        run: |
-          cosign verify-blob ${{ env.DOCKER_COMPOSE_NAME }}.tgz \
-            --bundle ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle \
-            --certificate-identity "https://github.com/${{ github.repository }}/.github/workflows/docker-compose-release.yaml@refs/heads/${{ env.GIT_REF }}" \
-            --certificate-oidc-issuer "https://token.actions.githubusercontent.com"
-
-      #
-      # Release
-      # TODO: Use gomplate to generate the Docker Compose release notes.
-      - name: Create release notes
-        run: |
-          grep _VERSION ${{ env.DOCKER_COMPOSE_WORKING_DIRECTORY }}/.env > VERSIONS.txt
-          cat << EOF > RELEASE-NOTES.md
-          $(cat ${{ env.DOCKER_COMPOSE_WORKING_DIRECTORY }}/README.md) 
-          ## Versions
-          $(printf -- "- %s\n" $(cat VERSIONS.txt))
-          ## Verification
-          To verify the integrity of the artifact using [Cosign](https://docs.sigstore.dev/signing/quickstart/):
-          \`\`\`shell
-          # Download Docker Compose artifact.
-          curl -LO https://github.com/${{ github.repository }}/releases/download/${{ env.DOCKER_COMPOSE_NAME }}/${{ env.DOCKER_COMPOSE_NAME }}.tgz
-          # Download Docker Compose Cosign bundle.
-          curl -LO https://github.com/${{ github.repository }}/releases/download/${{ env.DOCKER_COMPOSE_NAME }}/${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle
-          # Verify with cosign.
-          cosign verify-blob ${{ env.DOCKER_COMPOSE_NAME }}.tgz \\
-            --bundle ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle \\
-            --certificate-oidc-issuer "https://token.actions.githubusercontent.com" \\
-            --certificate-identity "https://github.com/${{ github.repository }}/.github/workflows/docker-compose-release.yaml@refs/heads/${{ env.GIT_REF }}"
-          \`\`\`
-          ## Notes
-          - **Release strategy:** Camunda Docker Compose release is a rolling release. Hence, it's always 1 artifact per Camunda minor version.
-          - **Latest update:** $(date)
-          EOF
-      - name: Create git tag
-        run: |
-          git tag ${{ env.DOCKER_COMPOSE_NAME }}
-      - name: Release on GitHub
-        id: gh-release
-        uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2
-        with:
-          name: ${{ env.DOCKER_COMPOSE_NAME }}
-          tag_name: ${{ env.DOCKER_COMPOSE_NAME }}
-          body_path: RELEASE-NOTES.md
-          files: |
-            ${{ env.DOCKER_COMPOSE_NAME }}.tgz
-            ${{ env.DOCKER_COMPOSE_NAME }}.cosign.bundle
-      - name: Add release URL to workflow summary
-        run: |
-          echo "⭐ Release URL: ${{steps.gh-release.outputs.url}}" >> $GITHUB_STEP_SUMMARY
+  exec:
+    needs: [init]
+    name: ${{ matrix.versions.name }}
+    strategy:
+      fail-fast: false
+      matrix:
+        versions:
+          - name: Camunda 8.3
+            camunda-version: 8.3
+          - name: Camunda 8.4
+            camunda-version: 8.5
+          - name: Camunda 8.5
+            camunda-version: 8.5
+          - name: Camunda 8.6
+            camunda-version: 8.6
+          - name: Camunda Alpha
+            camunda-version: alpha
+        exclude: ${{ fromJson(needs.init.outputs.unchanged-versions) }}
+    uses: ./.github/workflows/docker-compose-release-template.yaml
+    secrets: inherit
+    with:
+      camunda-version: ${{ matrix.versions.camunda-version }}
+      git-ref: ${{ github.ref }}
diff --git a/docker-compose/versions/camunda-8.3/README.md b/docker-compose/versions/camunda-8.3/README.md
@@ -3,3 +3,4 @@
 ## Usage
 
 For end user usage, please check the offical documentation of [Camunda 8 Self-Managed Docker Compose](https://docs.camunda.io/docs/8.3/self-managed/platform-deployment/docker/#docker-compose).
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -3,3 +3,4 @@
		## Usage

		For end user usage, please check the offical documentation of [Camunda 8 Self-Managed Docker Compose](https://docs.camunda.io/docs/8.3/self-managed/platform-deployment/docker/#docker-compose).