Skip to content

Commit a2e25af

Browse files
authored
Use gem for changelog generator (#2409)
1 parent 61f8615 commit a2e25af

2 files changed

Lines changed: 17 additions & 6 deletions

File tree

.github/workflows/cd_release.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,15 @@ jobs:
6767
# For the release-specific changelog
6868
echo "output_file=release_changelog.md" >> $GITHUB_OUTPUT
6969
70-
- name: Update changelog
71-
uses: docker://githubchangeloggenerator/github-changelog-generator:1.18.0
70+
- name: Set up Ruby
71+
uses: ruby/setup-ruby@v1
7272
with:
73-
args: --user "${{ github.repository_owner }}" --project "${{ steps.changelog_config.outputs.project }}" --token "${{ secrets.RELEASE_PAT_BOT }}" --release-branch "${{ steps.save_branch.outputs.publish_branch }}" --exclude-labels "${{ steps.changelog_config.outputs.exclude_labels }}"
73+
ruby-version: '3.3'
74+
75+
- name: Update changelog
76+
run: |
77+
gem install github_changelog_generator -v 1.18.0
78+
github_changelog_generator --user "${{ github.repository_owner }}" --project "${{ steps.changelog_config.outputs.project }}" --token "${{ secrets.RELEASE_PAT_BOT }}" --release-branch "${{ steps.save_branch.outputs.publish_branch }}" --exclude-labels "${{ steps.changelog_config.outputs.exclude_labels }}"
7479
7580
- name: Update API Reference docs and version - Commit changes and update tag
7681
run: uv run .github/utils/update_docs.sh

.github/workflows/ci_cd_updated_main.yml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,11 +83,17 @@ jobs:
8383
echo "project=$(echo $GITHUB_REPOSITORY | cut -d/ -f2- )" >> $GITHUB_OUTPUT
8484
echo "exclude_labels=duplicate,question,invalid,wontfix,dependency_updates,skip_changelog" >> $GITHUB_OUTPUT
8585
86-
- name: Update changelog with unreleased changes
86+
- name: Set up Ruby
8787
if: steps.release_check.outputs.release_run == 'false'
88-
uses: docker://githubchangeloggenerator/github-changelog-generator:1.18.0
88+
uses: ruby/setup-ruby@v1
8989
with:
90-
args: --user "${{ github.repository_owner }}" --project "${{ steps.changelog_config.outputs.project }}" --token ${{ secrets.RELEASE_PAT_BOT }} --release-branch "${{ env.DEFAULT_REPO_BRANCH }}" --future-release "Unreleased changes" --exclude-labels "${{ steps.changelog_config.outputs.exclude_labels }}"
90+
ruby-version: '3.3'
91+
92+
- name: Update changelog with unreleased changes
93+
if: steps.release_check.outputs.release_run == 'false'
94+
run: |
95+
gem install github_changelog_generator -v 1.18.0
96+
github_changelog_generator --user "${{ github.repository_owner }}" --project "${{ steps.changelog_config.outputs.project }}" --token ${{ secrets.RELEASE_PAT_BOT }} --release-branch "${{ env.DEFAULT_REPO_BRANCH }}" --future-release "Unreleased changes" --exclude-labels "${{ steps.changelog_config.outputs.exclude_labels }}"
9197
9298
- name: Deploy documentation
9399
if: steps.release_check.outputs.release_run == 'false'

0 commit comments

Comments
 (0)