Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow configuring changelog file for bump-version-release workflow #234

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Allow configuring changelog file for bump-version-release workflow #234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/workflows/bump-version-release.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/[email protected]
Expand Down
13 changes: 7 additions & 6 deletions docs/workflows/bump-version-release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,13 @@ jobs:

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| 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 .) |

<!-- AUTO-DOC-INPUT:END -->

Expand Down
Loading