Skip to content

Commit 6134dd2

Browse files
author
Marco Grassi
committed
docs: github action for docs
1 parent 88f8833 commit 6134dd2

2 files changed

Lines changed: 50 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Deploy MkDocs documentation to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
24+
- uses: actions/setup-python@v5
25+
with:
26+
python-version: "3.12"
27+
28+
- name: Install dependencies
29+
working-directory: docs
30+
run: pip install -r requirements.txt
31+
32+
- name: Build MkDocs site
33+
working-directory: docs
34+
run: mkdocs build --strict
35+
36+
- uses: actions/upload-pages-artifact@v3
37+
with:
38+
path: docs/site
39+
40+
deploy:
41+
needs: build
42+
runs-on: ubuntu-latest
43+
environment:
44+
name: github-pages
45+
url: ${{ steps.deployment.outputs.page_url }}
46+
steps:
47+
- id: deployment
48+
uses: actions/deploy-pages@v4
49+

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
**/src/test/resources/file/result
44
**/target
55
*.class
6+
docs/site/
67
release.properties

0 commit comments

Comments
 (0)