Skip to content

Commit 85cf761

Browse files
authored
Fix the version release workflow (#89)
The version release workflow added in #87 had a few issues, which are all fixed in this PR: - the step to create the git tag did not check out the repository, nor did it configure the git credentials properly - the same version string was used for both tagging and building the docs, while we currently use the `vX.Y.Z` format for the tag and `X.Y.Z` for the docs version - the doc building step did not specify a dependency on the tagging step, which meant it would run and publish the docs even if tagging was not successful
1 parent 16a66c1 commit 85cf761

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

.github/workflows/release.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,16 @@ jobs:
1414
push-tag:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- run: git tag -a ${{ inputs.version }} -m "Release ${{ inputs.version }}"
18-
- run: git push origin ${{ inputs.version }}
17+
- uses: actions/checkout@v4
18+
- name: Configure Git
19+
run: |
20+
git config user.name github-actions[bot]
21+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
22+
- run: |
23+
git tag -a v${{ inputs.version }} -m "Release v${{ inputs.version }}"
24+
git push origin v${{ inputs.version }}
1925
build-docs:
26+
needs: push-tag
2027
uses: ./.github/workflows/docs.yml
2128
with:
2229
versions: ${{ inputs.version }} stable

0 commit comments

Comments
 (0)