Skip to content

Merge pull request #325 from rackerlabs/new-cluster-deployment-rebase #337

Merge pull request #325 from rackerlabs/new-cluster-deployment-rebase

Merge pull request #325 from rackerlabs/new-cluster-deployment-rebase #337

Workflow file for this run

name: pages build and deployment
on:
push:
branches:
- main
paths:
- "mkdocs.yml"
- "docs/**"
- ".github/workflows/mkdocs.yml"
pull_request:
paths:
- "mkdocs.yml"
- "docs/**"
- ".github/workflows/mkdocs.yml"
workflow_dispatch:
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
- name: markdownlint
uses: nosborn/github-action-markdown-cli@9b5e871c11cc0649c5ac2526af22e23525fa344d # v3.3.0
with:
files: docs
config_file: .markdownlint.yml
- uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5
with:
python-version: 3.x
cache: pip
cache-dependency-path: requirements-docs.txt
- run: make docs
- uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
path: site/
deploy:
# depend on the docs being built
needs: build
# ensure we only run on commits to the main branch or manual workflows executions
if: ${{ github.ref == 'refs/heads/main' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch') }}
runs-on: ubuntu-latest
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: "github-pages"
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4