Skip to content

Added global user documentation #39

Added global user documentation

Added global user documentation #39

Workflow file for this run

name: Publish `main` Documentation
on: [push]
jobs:
build:
name: Publish Development Documentation
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
submodules: 'true'
- name: Set up Python
uses: actions/setup-python@v3
- name: Install Dependencies
run: |
pip install --disable-pip-version-check -r mkdocs_requirements.txt
- name: Configure Git
run: |
git config --local user.name "Doc Deploy Bot"
git config --local user.email "[email protected]"
- name: mike Deploy Main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
mike deploy --push dev
create_release:
needs: build
if: startsWith(github.ref, 'refs/tags/v')
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-tags: true
fetch-depth: 0
- name: Repair tag
run: git fetch -f origin ${{ github.ref }}:${{ github.ref }}
- name: Verify that the tag is annotated
run: if test x$(git for-each-ref ${{ github.ref }} | awk '{print $2}') = xtag; then /bin/true; else echo "\"${{ github.ref }}\" does not look like an annotated tag!"; /bin/false; fi
- name: Release
uses: softprops/action-gh-release@v1
with:
#prerelease: true
generate_release_notes: true