Skip to content

Commit 534cd4e

Browse files
Add CI for docs and ABOUT files
Adds GitHub actions CI for docs and about files. Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 8324538 commit 534cd4e

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: CI About Files
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-20.04
8+
9+
strategy:
10+
max-parallel: 4
11+
matrix:
12+
python-version: [3.7]
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v2
17+
18+
- name: Set up Python ${{ matrix.python-version }}
19+
uses: actions/setup-python@v2
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
23+
- name: Configure VirtualEnv
24+
run: ./configure --dev
25+
26+
- name: Activate VirtualEnv
27+
run: source bin/activate
28+
29+
#- name: Check About Files in thirdparty
30+
# run: ./bin/about check thirdparty/
31+
32+
- name: Check About Files in thirdparty
33+
run: ./bin/about check src/
34+
35+
- name: Check About Files in thirdparty
36+
run: ./bin/about check etc/
37+
38+
- name: Check About Files in thirdparty
39+
run: ./bin/about check scancode-toolkit.ABOUT

.github/workflows/ci-docs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: CI Documentation
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-20.04
8+
9+
strategy:
10+
max-parallel: 4
11+
matrix:
12+
python-version: [3.7]
13+
14+
steps:
15+
- name: Checkout code
16+
uses: actions/checkout@v2
17+
18+
- name: Set up Python ${{ matrix.python-version }}
19+
uses: actions/setup-python@v2
20+
with:
21+
python-version: ${{ matrix.python-version }}
22+
23+
- name: Give permission to run scripts
24+
run: chmod +x ./docs/scripts/doc8_style_check.sh
25+
26+
- name: Install Dependencies
27+
working-directory: ./docs
28+
run: pip install -r requirements.txt
29+
30+
- name: Check Sphinx Documentation build minimally
31+
working-directory: ./docs
32+
run: sphinx-build -E source build
33+
34+
- name: Check for documentation style errors
35+
working-directory: ./docs
36+
run: ./scripts/doc8_style_check.sh
37+

0 commit comments

Comments
 (0)