-
-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refs #147: Docs are deployed with every new release + Release should …
…now work again (#174) * refs #173: This change should explicitely grant proper permissions to the job that creates a new release. * refs #147: Added a test workflow to deploy docs site via GH Actions. This is a test commit. * refs #147: Fixed indentation, running another test. * refs #147: Specified working dir for the deployh command, running another test. * refs #147: Specified permissions, renamed job for better readability. Running another test. * refs #147: Changed a string back to test manual deploy. Running the last test. * refs #147: The gh pages deploy workflow triggers are now related to the actual release, not pushes on testing branch.
- Loading branch information
1 parent
6acb3fb
commit 83aea56
Showing
2 changed files
with
78 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
name: Publish updated documentation | ||
|
||
on: | ||
push: | ||
tags: | ||
- "v*.*.*" | ||
- "v*.*.*-alpha*" | ||
- "v*.*.*-beta*" | ||
- "v*.*.*-rc*" | ||
|
||
jobs: | ||
deploy-gh-pages: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Install Python environment | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.11 | ||
- name: Install MkDocs and dependencies | ||
run: > | ||
pip install | ||
mkdocs==1.5.3 | ||
mkdocs-nav-weight | ||
mkdocs-abs-rel-plugin | ||
mkdocs-add-number-plugin | ||
mkdocs-autolinks-plugin | ||
mkdocs-autorefs | ||
mkdocs-awesome-pages-plugin | ||
mkdocs-codeinclude-plugin | ||
mkdocs-enumerate-headings-plugin | ||
mkdocs-exclude | ||
mkdocs-exclude-search | ||
mkdocs-gallery | ||
mkdocs-gen-files | ||
mkdocs-git-authors-plugin | ||
mkdocs-git-committers-plugin-2 | ||
mkdocs-git-revision-date-localized-plugin | ||
mkdocs-img2fig-plugin | ||
mkdocs-include-markdown-plugin | ||
mkdocs-kroki-plugin | ||
mkdocs-literate-nav | ||
mkdocs-localsearch | ||
mkdocs-macros-plugin | ||
mkdocs-markdownextradata-plugin | ||
mkdocs-merge | ||
mkdocs-minify-plugin | ||
mkdocs-monorepo-plugin | ||
mkdocs-multirepo | ||
mkdocs-multirepo-plugin | ||
mkdocs-no-sitemap-plugin | ||
mkdocs-print-site-plugin | ||
mkdocs_pymdownx_material_extras | ||
mkdocs-safe-text-plugin | ||
mkdocs-same-dir | ||
mkdocs-section-index | ||
mkdocs-simple-hooks | ||
mkdocs-simple-plugin | ||
mkdocs-swagger-ui-tag | ||
mkdocs-redirects | ||
mkdocs-versioning | ||
mkdocs-with-confluence | ||
mkdocstrings | ||
mkdocs-alabaster | ||
mkdocs-cinder | ||
mkdocs-kpn | ||
mkdocs-material | ||
neoteroi-mkdocs | ||
markdown-include | ||
pygments | ||
pymdown-extensions | ||
- name: Deploy to production | ||
working-directory: ./docs | ||
run: mkdocs gh-deploy --force --clean --verbose |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters