Skip to content

Commit

Permalink
Add documentation generator
Browse files Browse the repository at this point in the history
  • Loading branch information
jhawksley-intergral committed Dec 17, 2024
1 parent b0a00b0 commit ce342be
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/workflows/generate_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Generate Docs

on:
push:
branches:
- gh-pages

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

jobs:

get_index:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: gh-pages
- name: upload index
uses: actions/upload-artifact@v3
with:
name: helm_index
path: index.yaml

build_docs:
needs: get_index
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
ref: master
- run: pip install helm_mkdocs mkdocs-material
- run: |
helm-mkdocs ./charts/katie -o docs_out/katie
- run: cp README.md docs_out/index.md
- run: cp styles.css docs_out/styles.css
- run: mkdocs build
- name: Download index
uses: actions/download-artifact@v3
with:
name: helm_index
- run: cp index.yaml _site/index.yaml
- name: Upload artifact
uses: actions/upload-pages-artifact@v1

deploy:
needs: build_docs
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

0 comments on commit ce342be

Please sign in to comment.