Add newlines in batch docs for proper markdown lists #461
Workflow file for this run
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: build-docs | |
on: | |
pull_request: | |
branches: [ main ] | |
paths: | |
- '.github/workflows/**' | |
- 'docs/**' | |
- 'cmd/**' | |
- 'core/**' | |
- '*/CHANGELOG.md' | |
- 'requirements.txt' | |
workflow_dispatch: | |
inputs: | |
deploy: | |
description: 'deploy the built docs' | |
type: boolean | |
default: false | |
required: false | |
jobs: | |
build: | |
name: Build Docs | |
runs-on: ubuntu-20.04 | |
steps: | |
- name: Setup Go | |
uses: actions/setup-go@v5 | |
with: | |
go-version: 1.22 | |
- name: Check out code | |
uses: actions/checkout@v4 | |
- 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: Build docs | |
run: | | |
go run main.go gen | |
pip install -r requirements.txt | |
mkdocs build | |
- name: Deploy Docs | |
if: "${{ github.event.inputs.deploy }}" | |
uses: peaceiris/[email protected] | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: ./site | |
cname: changie.dev |