Merge pull request #118 from Joon-Klaps/master #24
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
name: Publish Docs On Change | |
on: | |
push: | |
branches: | |
- main | |
- dev | |
- master | |
permissions: | |
contents: write | |
jobs: | |
build: | |
name: Deploy docs | |
runs-on: ubuntu-latest | |
if: github.event.repository.fork == false | |
defaults: | |
run: | |
shell: bash -x -l {0} | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # fetch all commits/branches | |
- name: Configure Git Credentials | |
run: | | |
git config user.name github-actions[bot] | |
git config user.email 41898282+github-actions[bot]@users.noreply.github.com | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV | |
- uses: actions/cache@v4 | |
with: | |
key: mkdocs-material-${{ env.cache_id }} | |
path: .cache | |
restore-keys: | | |
mkdocs-material- | |
- name: Install dependencies | |
run: pip install mkdocs-material pymdown-extensions pillow cairosvg mike nf-core | |
- name: Build parameter docs | |
run: nf-core schema docs --format markdown --columns parameter,description,default --output docs/parameters.md --force | |
- name: Build docs | |
run: mike deploy --push --update-aliases ${{ env.plugin_version }} latest | |
- name: Set default docs | |
run: mike set-default --push latest |