ci: Delete/remove release tag after CHANGELOG.rst modified in main, build docs as a part of the release workflow after github release
#120
Conversation
| @@ -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 | |||
There was a problem hiding this comment.
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!
bobleesj
changed the title
|
@sbillinge ready for review |
|
please see my comments on the diffpy.utils PR. I wonder if this is the right approach actually. |
| @@ -97,13 +129,13 @@ jobs: | |||
| token: ${{ secrets.GITHUB_TOKEN }} | |||
|
|
|||
| github-release: | |||
| needs: [update-changelog] | |||
| needs: [delete-create-new-tag] | |||
There was a problem hiding this comment.
must have delete-create-new-tag which depends on build-changelog
@sbillinge ready for review - tested using a dummy repo/org. https://bobleesj-test-org.github.io/bobleesj.release/release.html |
bobleesj
changed the title
main, build docs as a part of the release workflow after github release
|
looks good, let's try it..... I will merge. Does diffpy.utils have to be updated, or this will just run if I merge it into v0? |
No updates needed.. on diffpy.utils. |
|
|
Closes #94
I think it is better to read this PR diffpy/diffpy.utils#312 first since it's related and I provide a bit more context on the problem.
Please see in-line comments: