Skip to content

Commit

Permalink
Add a workflow to release a new stable version (#87)
Browse files Browse the repository at this point in the history
This PR adds a new GitHub Action that partially automates the process of
releasing a new stable version of `syntheseus`. It tags the latest
commit with an appropriate version tag and builds the docs (using a
generalized version of the docs building pipeline).
  • Loading branch information
kmaziarz authored Apr 10, 2024
1 parent 0de1ca2 commit 75eb796
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
7 changes: 6 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ name: Docs
on:
push:
branches: [ main ]
workflow_call:
inputs:
versions:
required: true
type: string
workflow_dispatch:

permissions:
Expand All @@ -29,4 +34,4 @@ jobs:
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material mkdocs-jupyter mike
- run: mike deploy --push --update-aliases dev
- run: mike deploy --push --update-aliases ${{ inputs.versions != '' && inputs.versions || 'dev' }}
22 changes: 22 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Release Stable Version

on:
workflow_dispatch:
inputs:
version:
required: true
type: string

permissions:
contents: write

jobs:
push-tag:
runs-on: ubuntu-latest
steps:
- run: git tag -a ${{ inputs.version }} -m "Release ${{ inputs.version }}"
- run: git push origin ${{ inputs.version }}
build-docs:
uses: ./.github/workflows/docs.yml
with:
versions: ${{ inputs.version }} stable

0 comments on commit 75eb796

Please sign in to comment.