Skip to content

Commit 5a285e8

Browse files
author
Jermiah
committed
Update GitHub Actions workflow and add
documentation generation
1 parent e372b3a commit 5a285e8

File tree

2 files changed

+53
-1
lines changed

2 files changed

+53
-1
lines changed

.github/workflows/main.yml

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Unit Tests
33
on: [push]
44

55
jobs:
6-
build:
6+
Continuous-Integration:
77
runs-on: ${{ matrix.os }}
88
strategy:
99
matrix:
@@ -27,3 +27,52 @@ jobs:
2727
- name: Test with pytest
2828
run: poetry run pytest
2929

30+
- name: Use Codecov to track coverage
31+
uses: codecov/codecov-action@v2
32+
with:
33+
file: ./coverage.xml
34+
35+
- name: Build documentation
36+
run: poetry run make html --directory docs/
37+
38+
# Continuous-Development:
39+
# needs: Continuous-Integration
40+
41+
# if: github.event_name == 'push' && github.ref == 'refs/heads/main'
42+
43+
# runs-on: ubuntu-latest
44+
45+
# steps:
46+
# - uses: actions/checkout@v2
47+
# with:
48+
# fetch-depth: 0
49+
50+
# - name: Set up Python 3.12
51+
# uses: actions/setup-python@v2
52+
# with:
53+
# python-version: 3.12
54+
55+
# - name: Install poetry
56+
# uses: snok/install-poetry@v1
57+
58+
# - name: Install package
59+
# run: poetry install
60+
61+
# - name: Build package
62+
# run: poetry build
63+
64+
# - name: Publish package
65+
# uses: pypa/gh-action-pypi-publish@27a0a2a
66+
# with:
67+
# user: __token__
68+
# password: ${{ secrets.PYPI_TOKEN }}
69+
# repository_url: https://upload.pypi.org/legacy/
70+
# build_dir: ./dist
71+
72+
# - name: Publish documentation
73+
# uses: maxheld83/ghpages@v0.2.1
74+
# with:
75+
# build_dir: docs/_build/html
76+
# target_branch: gh-pages
77+
# committer_name: "GitHub Actions"
78+
# committer_email: "

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44
# NBIA Toolkit
55
- Packaged code to access the NBIA REST API
66

7+
See Documentation at [NBIA-Toolkit Read The Docs](https://nbia-toolkit.readthedocs.io/en/latest/)
8+
9+
Wiki is empty for now:
710
See the [Wiki](https://github.com/jjjermiah/NBIA-toolkit/wiki) for more information.
811

912
# nbiatoolkit

0 commit comments

Comments
 (0)