This repository has been archived by the owner on Jun 25, 2024. It is now read-only.
Merge pull request #922 from bshephar/rename-spec-play #1316
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: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
pull_request: | |
branches: | |
- main | |
paths: | |
- .github/workflows/docs* | |
- api/v1beta1/** | |
- docs/** | |
- Gemfile | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Install Go | |
uses: actions/setup-go@v3 | |
with: | |
go-version: 1.20.x | |
- uses: actions/checkout@v4 | |
with: | |
# this fetches all branches. Needed because we need gh-pages branch for deploy to work | |
fetch-depth: 0 | |
- uses: ruby/setup-ruby@v1.160.0 | |
with: | |
ruby-version: '3.2' | |
- name: Install Asciidoc | |
run: make docs-dependencies | |
- name: Build docs | |
run: | | |
make docs | |
cp docs/index.html index.html | |
- name: Prepare gh-pages branch | |
run: | | |
git config user.name github-actions | |
git config user.email github-actions@github.com | |
git branch -D gh-pages &>/dev/null || true | |
git checkout -b gh-pages 19b4601e2a3943f8ed5dcba4ee941a75ed1b6a9a | |
- name: Commit asciidoc docs | |
run: | | |
mkdir user dev | |
mv docs_build/dataplane/index-upstream.html user/index.html | |
mv docs_build/dataplane/dev.html dev/index.html | |
git add index.html user/index.html dev/index.html | |
git commit -m "Rendered docs" | |
- name: Push rendered docs to gh-pages | |
if: github.event_name == 'push' && github.ref == 'refs/heads/main' | |
run: | | |
git push --force origin gh-pages |