Skip to content

Commit db2e9eb

Browse files
author
zillionare
committed
🐎ci: add release document workflow
1 parent 286fb80 commit db2e9eb

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

.github/workflows/docs.yml

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Publish document if it's tagged with 'doc*'
2+
3+
name: document release
4+
5+
# Controls when the action will run.
6+
on:
7+
# Triggers the workflow on push or pull request events but only for the master branch
8+
push:
9+
branch: release
10+
tags:
11+
- 'doc*'
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
17+
jobs:
18+
# This workflow contains a single job called "build"
19+
release:
20+
name: release document
21+
runs-on: ubuntu-latest
22+
23+
strategy:
24+
matrix:
25+
python-versions: [3.8]
26+
27+
# Steps represent a sequence of tasks that will be executed as part of the job
28+
steps:
29+
30+
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
31+
- uses: actions/checkout@v2
32+
33+
34+
- uses: actions/setup-python@v2
35+
with:
36+
python-version: ${{ matrix.python-versions }}
37+
38+
- name: Install dependencies
39+
run: |
40+
python -m pip install --upgrade pip
41+
pip install tox-gh-actions poetry
42+
43+
- name: pre-publish documentation
44+
run: |
45+
poetry install -E dev
46+
poetry run mkdocs build
47+
48+
- name: publish documentation
49+
uses: peaceiris/actions-gh-pages@v3
50+
with:
51+
personal_token: ${{ secrets.PERSONAL_TOKEN }}
52+
publish_dir: ./site

0 commit comments

Comments
 (0)