Skip to content

Commit ae48804

Browse files
committed
ci: publish the docs after a release succeeds
1 parent f34124c commit ae48804

3 files changed

Lines changed: 10 additions & 0 deletions

File tree

‎.github/workflows/build-and-publish-docs-on-dispatch.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
name: Build and Publish Docs on Dispatch
22

3+
# Called by release-github-on-tag.yml after a successful release.
34
on:
5+
workflow_call:
46
workflow_dispatch:
57

68
permissions:
@@ -17,6 +19,7 @@ jobs:
1719
- name: Check out libdiffpy
1820
uses: actions/checkout@v6
1921
with:
22+
ref: ${{ github.ref }} # The release tag is recreated after the changelog update
2023
fetch-depth: 0 # Version is read from git tags
2124

2225
- name: Initialize miniconda

‎.github/workflows/release-github-on-tag.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,9 @@ jobs:
3030
uses: scikit-package/release-scripts/.github/workflows/_release-github.yml@v0
3131
secrets:
3232
PAT_TOKEN: ${{ secrets.PAT_TOKEN }}
33+
34+
docs-release:
35+
needs: [release-github]
36+
permissions:
37+
contents: write
38+
uses: ./.github/workflows/build-and-publish-docs-on-dispatch.yml

‎news/ci.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* Run matrix testing with SCons on Ubuntu and macOS (arm64 and Intel) instead of the Python-only pytest matrix.
88
* Run matrix testing before every GitHub release and block the release if any test fails.
99
* Build and deploy docs with Sphinx directly instead of the Python-only scikit-package docs workflow.
10+
* Publish docs automatically after a successful GitHub release.
1011
* Update the release checklist for GitHub and conda-forge releases without PyPI.
1112

1213
**Deprecated:**

0 commit comments

Comments
 (0)