Run publish docs action on release
- Document this change in the readme
This commit is contained in:
parent
b8872d4098
commit
a0f6e16958
2 changed files with 12 additions and 8 deletions
3
.github/workflows/publish-docs.yml
vendored
3
.github/workflows/publish-docs.yml
vendored
|
@ -1,6 +1,9 @@
|
||||||
name: Publish docs
|
name: Publish docs
|
||||||
|
|
||||||
on:
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
inputs:
|
inputs:
|
||||||
ref:
|
ref:
|
||||||
|
|
|
@ -69,12 +69,13 @@ when hacking on the site generator itself.
|
||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
The documentation is automatically built
|
The documentation is built
|
||||||
and uploaded to GitHub pages
|
and uploaded to GitHub Pages
|
||||||
on every commit to `master`.
|
using [GitHub Actions][config].
|
||||||
|
|
||||||
However,
|
The workflow is run automatically on a new release.
|
||||||
if you wish to deploy the docs manually,
|
For changes not tied to a release (e.g. typo fixes),
|
||||||
then you can do that by running `./deploy.sh`.
|
a maintainer can trigger it manually –
|
||||||
You will need push access to the Maud repository
|
please ask if you'd like this.
|
||||||
to do this.
|
|
||||||
|
[config]: ../.github/workflows/publish-docs.yml
|
||||||
|
|
Loading…
Add table
Reference in a new issue