feat: documentation versioning (#504) #256
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: Deploy Docs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
- 'mkdocs.yml' | |
tags: | |
- v** | |
pull_request: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
- '.github/workflows/docs.yml' | |
- 'mkdocs.yml' | |
- 'pixi.*' | |
workflow_dispatch: | |
# Allow one concurrent deployment | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
build-docs: | |
if: github.ref != 'refs/heads/main' | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: prefix-dev/[email protected] | |
with: | |
pixi-version: v0.10.0 | |
cache: true | |
- name: Build docs for test | |
run: | | |
pixi run build-docs | |
docs-release: | |
# Don't run on forks | |
if: startsWith(github.event.ref, 'refs/tags/v') | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: prefix-dev/[email protected] | |
with: | |
pixi-version: v0.10.0 | |
cache: true | |
- name: Configure Git user | |
run: | | |
git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
git config --local user.name "github-actions[bot]" | |
- name: Extract branch name | |
shell: bash | |
run: echo "##[set-output name=tag;]$(echo ${GITHUB_REF#refs/heads/})" | |
id: extract_branch | |
- name: Deploy with mike 🚀 | |
env: | |
RELEASE_VERSION: ${{ steps.extract_branch.outputs.tag }} | |
run: | | |
pixi run deploy-latest | |
docs-dev: | |
# Don't run on forks | |
if: github.ref == 'refs/heads/main' | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: prefix-dev/[email protected] | |
with: | |
pixi-version: v0.10.0 | |
cache: true | |
- name: Configure Git user | |
run: | | |
git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
git config --local user.name "github-actions[bot]" | |
- name: Deploy with mike 🚀 | |
run: | | |
pixi run deploy-dev |