Zeebe Changelog

Generate changelog for Camunda 8 project.

Example usage

  export ZCL_FROM_REV=PREV_VERSION
  export ZCL_TARGET_REV=TARGET_VERSION

  # This will add labels to the issues in GitHub. You can verify this step by looking at closed issues. They should now be tagged with the release.
  zcl add-labels \
    --token=$GITHUB_TOKEN \
    --from=$ZCL_FROM_REV \
    --target=$ZCL_TARGET_REV \
    --label="version:$ZCL_TARGET_REV" \
    --org camunda --repo camunda

  # Optional: Configure the number of concurrent workers (default: 10)
  # This can speed up labeling of large numbers of issues
  zcl add-labels \
    --token=$GITHUB_TOKEN \
    --from=$ZCL_FROM_REV \
    --target=$ZCL_TARGET_REV \
    --label="version:$ZCL_TARGET_REV" \
    --org camunda --repo camunda \
    --workers=20

  # Optional: Dry run to preview which issues would be labeled without making any changes
  zcl add-labels \
    --token=$GITHUB_TOKEN \
    --from=$ZCL_FROM_REV \
    --target=$ZCL_TARGET_REV \
    --label="version:$ZCL_TARGET_REV" \
    --org camunda --repo camunda \
    --dry-run

  # This command will print markdown code to the console. You will need to manually insert this output into the release draft.
  zcl generate \
     --token=$GITHUB_TOKEN \
     --label="version:$ZCL_TARGET_REV" \
     --org camunda --repo camunda

Release ZCL

• [Prerequisite] Install goreleaser v2
  • go install github.com/goreleaser/goreleaser/v2@latest
• Create a new tag with the latest changes:
  • Create tag local: git tag <version>
  • Push tag: git push origin <version>
• Release ZCL
  • Run goreleaser:

    rm -rf dist/
    GITHUB_TOKEN=$(gh auth token) $(go env GOPATH)/bin/goreleaser release
    

  • Verify on release page