Skip to content

Commit

Permalink
Add github action for docs deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
francbartoli committed Feb 20, 2024
1 parent b58b7d5 commit f6472fd
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 1 deletion.
24 changes: 24 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Deploy MkDocs Site

on:
push:
branches:
- master
jobs:
deploy-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- name: Setup Python
uses: actions/[email protected]
with:
python-version: "3.10"
- name: Install dependencies
run: pip install mkdocs mkdocs-material termynal
- name: Build MkDocs site
run: mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.MY_GITHUB_TOKEN }}
publish_dir: ./docs_build/site
1 change: 0 additions & 1 deletion .github/workflows/openapi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ jobs:
run: |
echo 'extends: ["spectral:oas"]' > .spectral.oas3.yaml
# Create OWASP API Security 10 ruleset
- name: Create OWASP API Security 10
run: |
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ venv.bak/

# mkdocs documentation
/site
/docs_build

# mypy
.mypy_cache/
Expand Down

0 comments on commit f6472fd

Please sign in to comment.