Skip to content

ci: Delete/remove release tag after CHANGELOG.rst modified in main, build docs as a part of the release workflow after github release #120

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

Merged
sbillinge merged 7 commits into from
Jan 1, 2025
Merged

ci: Delete/remove release tag after CHANGELOG.rst modified in main, build docs as a part of the release workflow after github release #120

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d8da3c1
Build docs as a part of the release workflow after github release
bobleesj Jan 1, 2025
02cf636
Add delete and create new tag
bobleesj Jan 1, 2025
0bffa6b
Add better description
bobleesj Jan 1, 2025
8915dfe
fetch tags before delete
bobleesj Jan 1, 2025
c523ee3
check out github ref and fix success for delete create tag
bobleesj Jan 1, 2025
a14d7bf
fix: add result after needs to have success for github release
bobleesj Jan 1, 2025
259522b
fix: bring pypi publish back to original release workflow
bobleesj Jan 1, 2025
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
8 changes: 8 additions & 0 deletions .github/workflows/_build-wheel-release-upload.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,14 @@ jobs:
body_path: CHANGELOG.txt
token: ${{ secrets.GITHUB_TOKEN }}

docs:
needs: [github-pre-release, github-release]
if: always()
uses: ./.github/workflows/_publish-docs-on-release.yml
with:
project: ${{ inputs.project }}
c_extension: ${{ inputs.c_extension }}

pypi-publish:
needs: [github-pre-release, github-release]
runs-on: ubuntu-latest
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/_publish-docs-on-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ on:
type: boolean

jobs:
docs:
build-deploy:
defaults:
run:
shell: bash -l {0}
Expand All @@ -35,7 +35,7 @@ jobs:
- name: Check out ${{ inputs.project }}
uses: actions/checkout@v4
with:
fetch-depth: 0 # Fetches branches and tags
ref: main # Fetch the main branch with CHANGELOG.rst modified during full release
Copy link
Contributor Author

@bobleesj bobleesj Jan 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Problem 2 - release notes never displayed the latest version

I found the source of the problem why changelog didn't show the latest version upon release.

When push a tag (commit) to upstream, the tag does not contain updated CHANGELOG.rst. The CHANGELOG.rst is modified during the CI which has an additional commit in main.

Hence, when we build a doc, we should checkout main instead of the tag!


- name: Initialize miniconda
uses: conda-incubator/setup-miniconda@v3
Expand Down