Skip to content

Merge pull request #1142 from openstack-k8s-operators/renovate/openst… #8

Merge pull request #1142 from openstack-k8s-operators/renovate/openst…

Merge pull request #1142 from openstack-k8s-operators/renovate/openst… #8

Workflow file for this run

name: Build Docs
on:
workflow_dispatch:
push:
branches:
- main
pull_request:
branches:
- main
paths:
- .github/workflows/docs*
- apis/client/v1beta1/**
- apis/core/v1beta1/**
- apis/dataplane/v1beta1/**
- docs/**
- Gemfile
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Install Go
uses: actions/setup-go@v3
with:
go-version: 1.21.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/[email protected]
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 [email protected]
git branch -D gh-pages &>/dev/null || true
git checkout --orphan gh-pages
git reset
- name: Commit asciidoc docs
run: |
mkdir ctlplane dataplane
mv docs_build/openstack/ctlplane-upstream.html ctlplane/index.html
mv docs_build/openstack/dataplane-upstream.html dataplane/index.html
git add index.html ctlplane/index.html dataplane/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