docs: Update executive summary with NSA/CISA hardening guide references #6
This file contains hidden or 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 MkDocs | |
on: | |
push: | |
branches: | |
- main | |
paths: | |
- 'docs/**' | |
- 'mkdocs.yml' | |
- '.github/workflows/deploy-docs.yml' | |
permissions: | |
contents: write | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
# Set up Python and cache dependencies | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: 3.x | |
cache: pip | |
cache-dependency-path: docs/requirements.txt | |
# Install Python dependencies | |
- name: Install Python dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r docs/requirements.txt | |
# Set up Node.js and cache dependencies | |
- name: Set up Node.js | |
uses: actions/setup-node@v3 | |
with: | |
node-version: 18 | |
cache: npm | |
cache-dependency-path: docs/package-lock.json | |
# Install Node.js dependencies | |
- name: Install Node.js dependencies | |
working-directory: ./docs | |
run: npm ci || npm install | |
# Lint Markdown files (but don't fail the build) | |
- name: Lint Markdown files | |
working-directory: ./docs | |
run: npm run lint || echo "Lint check skipped, continuing deployment" | |
# Build and validate documentation | |
- name: Build documentation with validation | |
run: mkdocs build --strict | |
# Deploy to GitHub Pages | |
- name: Deploy documentation | |
run: | | |
git config --local user.email "github-actions[bot]@users.noreply.github.com" | |
git config --local user.name "github-actions[bot]" | |
mkdocs gh-deploy --force |