Skip to content

Commit f16e00f

Browse files
committed
Add GitHub actions
1 parent be78b67 commit f16e00f

File tree

4 files changed

+112
-1
lines changed

4 files changed

+112
-1
lines changed

.github/workflows/build.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
2+
# SPDX-License-Identifier: CC0-1.0
3+
4+
name: Build documentation
5+
6+
on:
7+
push:
8+
branches:
9+
- '**'
10+
- '!main'
11+
pull_request:
12+
13+
jobs:
14+
build:
15+
runs-on: ubuntu-22.04
16+
steps:
17+
- uses: actions/checkout@v3
18+
- uses: actions/setup-python@v4
19+
with:
20+
python-version: '3.11'
21+
cache: 'pip'
22+
- name: Install dependencies
23+
run: pip install -r requirements.txt
24+
- name: Run REUSE lint
25+
run: reuse lint
26+
- name: Build
27+
run: mkdocs build --strict

.github/workflows/deploy.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
2+
# SPDX-License-Identifier: CC0-1.0
3+
4+
name: Build and deploy documentation
5+
6+
on:
7+
push:
8+
branches:
9+
- main
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-22.04
14+
steps:
15+
- uses: actions/checkout@v3
16+
- uses: actions/setup-python@v4
17+
with:
18+
python-version: '3.11'
19+
cache: 'pip'
20+
- name: Install dependencies
21+
run: pip install -r requirements.txt
22+
- name: Run REUSE lint
23+
run: reuse lint
24+
- uses: actions/configure-pages@v3
25+
- name: Build
26+
run: mkdocs build --strict
27+
- name: Upload artifact
28+
uses: actions/upload-pages-artifact@v2
29+
with:
30+
path: "site/"
31+
32+
deploy:
33+
needs: build
34+
runs-on: ubuntu-22.04
35+
permissions:
36+
pages: write
37+
id-token: write
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deployment.outputs.page_url }}
41+
steps:
42+
- name: Deploy to GitHub Pages
43+
id: deployment
44+
uses: actions/deploy-pages@v2

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
22
# SPDX-License-Identifier: GFDL-1.3-only
33

4-
site_name: swift Documentation
4+
site_name: swift pilot client Documentation
5+
site_url: https://swift-project.github.io/docs
56

67
# repo_url: https://github.com/swift-project/pilotclient
78

requirements.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
2+
# SPDX-License-Identifier: CC0-1.0
3+
4+
Babel==2.13.0
5+
binaryornot==0.4.4
6+
boolean.py==4.0
7+
certifi==2023.7.22
8+
chardet==5.2.0
9+
charset-normalizer==3.3.0
10+
click==8.1.7
11+
colorama==0.4.6
12+
docopt==0.6.2
13+
ghp-import==2.1.0
14+
idna==3.4
15+
Jinja2==3.1.2
16+
license-expression==30.1.1
17+
Markdown==3.5
18+
MarkupSafe==2.1.3
19+
mergedeep==1.3.4
20+
mkdocs==1.5.3
21+
mkdocs-material==9.4.6
22+
mkdocs-material-extensions==1.3
23+
packaging==23.2
24+
paginate==0.5.6
25+
pathspec==0.11.2
26+
platformdirs==3.11.0
27+
Pygments==2.16.1
28+
pymdown-extensions==10.3.1
29+
python-dateutil==2.8.2
30+
python-debian==0.1.49
31+
PyYAML==6.0.1
32+
pyyaml_env_tag==0.1
33+
regex==2023.10.3
34+
requests==2.31.0
35+
reuse==2.1.0
36+
six==1.16.0
37+
urllib3==2.0.7
38+
watchdog==3.0.0
39+
yarg==0.1.9

0 commit comments

Comments
 (0)