Skip to content

Commit e02562f

Browse files
Add CI for docs and ABOUT files
Adds GitHub actions CI for docs and about files. Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 8324538 commit e02562f

2 files changed

Lines changed: 78 additions & 0 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
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 3.9 not supported until next scancode-toolkit version
13+
python-version: [3.7]
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v2
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v2
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Configure VirtualEnv
25+
run: ./configure --dev
26+
27+
- name: Activate VirtualEnv
28+
run: source bin/activate
29+
30+
#- name: Check About Files in thirdparty
31+
# run: ./bin/about check thirdparty/
32+
33+
- name: Check About Files in thirdparty
34+
run: ./bin/about check src/
35+
36+
- name: Check About Files in thirdparty
37+
run: ./bin/about check etc/
38+
39+
- name: Check About Files in thirdparty
40+
run: ./bin/about check scancode-toolkit.ABOUT

.github/workflows/ci-docs.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
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 3.9 not supported until next scancode-toolkit version
13+
python-version: [3.7]
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v2
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v2
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Give permission to run scripts
25+
run: chmod +x ./docs/scripts/doc8_style_check.sh
26+
27+
- name: Install Dependencies
28+
working-directory: ./docs
29+
run: pip install -r requirements.txt
30+
31+
- name: Check Sphinx Documentation build minimally
32+
working-directory: ./docs
33+
run: sphinx-build -E source build
34+
35+
- name: Check for documentation style errors
36+
working-directory: ./docs
37+
run: ./scripts/doc8_style_check.sh
38+

0 commit comments

Comments
 (0)