From c64bca98e9bcf936909a7761cae07cbde231d869 Mon Sep 17 00:00:00 2001 From: Salomon Popp Date: Wed, 8 Jan 2025 14:26:08 +0100 Subject: [PATCH] Allow configuring changelog file for bump-version-release workflow --- .github/workflows/bump-version-release.yaml | 7 ++++++- docs/workflows/bump-version-release/README.md | 13 +++++++------ 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.github/workflows/bump-version-release.yaml b/.github/workflows/bump-version-release.yaml index 15d416df9..351f562eb 100644 --- a/.github/workflows/bump-version-release.yaml +++ b/.github/workflows/bump-version-release.yaml @@ -13,6 +13,11 @@ on: required: false default: true type: boolean + changelog-file: + description: Path to the changelog file in the GitHub repository + required: false + default: "CHANGELOG.md" + type: string changelog-config: description: "Changelog config path." required: false @@ -74,7 +79,7 @@ jobs: with: github-token: ${{ secrets.github-token }} tag: ${{ steps.bump-version.outputs.release-version }} - changelog-file: CHANGELOG.md + changelog-file: ${{ inputs.changelog-file }} - name: Commit and push changes including .bumpversion.cfg file uses: bakdata/ci-templates/actions/commit-and-push@v1.6.0 diff --git a/docs/workflows/bump-version-release/README.md b/docs/workflows/bump-version-release/README.md index 2f70664a3..5353de368 100644 --- a/docs/workflows/bump-version-release/README.md +++ b/docs/workflows/bump-version-release/README.md @@ -61,12 +61,13 @@ jobs: -| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | -| ----------------- | ------- | -------- | ------- | --------------------------------------------------------------- | -| changelog | boolean | false | `true` | Create changelog for release. | -| changelog-config | string | false | | Changelog config path. | -| release-type | string | true | | Scope of the release (major, minor or patch). | -| working-directory | string | false | `"."` | Working directory containing `.bumpversion.cfg`. (Default is .) | +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +| ----------------- | ------- | -------- | ---------------- | --------------------------------------------------------------- | +| changelog | boolean | false | `true` | Create changelog for release. | +| changelog-config | string | false | | Changelog config path. | +| changelog-file | string | false | `"CHANGELOG.md"` | Path to the changelog file in the GitHub repository | +| release-type | string | true | | Scope of the release (major, minor or patch). | +| working-directory | string | false | `"."` | Working directory containing `.bumpversion.cfg`. (Default is .) |