diff --git a/.github/workflows/cd_release.yml b/.github/workflows/cd_release.yml index 51ff7007..d35caff5 100644 --- a/.github/workflows/cd_release.yml +++ b/.github/workflows/cd_release.yml @@ -127,7 +127,7 @@ jobs: exclude_labels: "${{ inputs.changelog_exclude_labels }}" - name: Move CHANGELOG.md - run: mv CHANGELOG.md ./main/CHANGELOG.md + run: mv -f CHANGELOG.md ./main/CHANGELOG.md - name: Set up git user run: | diff --git a/.github/workflows/ci_cd_updated_default_branch.yml b/.github/workflows/ci_cd_updated_default_branch.yml index 07ba528b..d7a289c8 100644 --- a/.github/workflows/ci_cd_updated_default_branch.yml +++ b/.github/workflows/ci_cd_updated_default_branch.yml @@ -93,6 +93,16 @@ on: required: false type: boolean default: false + changelog_exclude_tags_regex: + description: "A regular expression matching any tags that should be excluded from the CHANGELOG.md." + required: false + type: string + default: "" + changelog_exclude_labels: + description: "Comma-separated list of labels to exclude from the CHANGELOG.md." + required: false + type: string + default: "" secrets: PAT: description: "A personal access token (PAT) with rights to update the `permanent_dependencies_branch`. This will fallback on `GITHUB_TOKEN`." @@ -233,6 +243,20 @@ jobs: unprotect_reviews: true path: main + # Note: This updated changelog will only exist for the `latest` documentation + # release. + - name: Update changelog with unreleased changes + uses: CharMixer/auto-changelog-action@v1 + with: + token: ${{ secrets.GITHUB_TOKEN }} + release_branch: ${{ inputs.default_repo_branch }} + exclude_tags_regex: "${{ inputs.changelog_exclude_tags_regex }}" + exclude_labels: "${{ inputs.changelog_exclude_labels }}" + future_release: "Unreleased changes" + + - name: Move CHANGELOG.md + run: mv -f CHANGELOG.md ./main/CHANGELOG.md + - name: Deploy documentation if: env.RELEASE_RUN == 'false' && ( ! inputs.test ) run: mike deploy --push --remote origin --branch gh-pages --update-aliases --config-file mkdocs.yml latest ${{ inputs.default_repo_branch }}