Skip to content

Commit

Permalink
Update GitHub Actions workflow and add
Browse files Browse the repository at this point in the history
documentation generation
  • Loading branch information
Jermiah committed Nov 20, 2023
1 parent e372b3a commit 5a285e8
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 1 deletion.
51 changes: 50 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Unit Tests
on: [push]

jobs:
build:
Continuous-Integration:
runs-on: ${{ matrix.os }}
strategy:
matrix:
Expand All @@ -27,3 +27,52 @@ jobs:
- name: Test with pytest
run: poetry run pytest

- name: Use Codecov to track coverage
uses: codecov/codecov-action@v2
with:
file: ./coverage.xml

- name: Build documentation
run: poetry run make html --directory docs/

# Continuous-Development:
# needs: Continuous-Integration

# if: github.event_name == 'push' && github.ref == 'refs/heads/main'

# runs-on: ubuntu-latest

# steps:
# - uses: actions/checkout@v2
# with:
# fetch-depth: 0

# - name: Set up Python 3.12
# uses: actions/setup-python@v2
# with:
# python-version: 3.12

# - name: Install poetry
# uses: snok/install-poetry@v1

# - name: Install package
# run: poetry install

# - name: Build package
# run: poetry build

# - name: Publish package
# uses: pypa/gh-action-pypi-publish@27a0a2a
# with:
# user: __token__
# password: ${{ secrets.PYPI_TOKEN }}
# repository_url: https://upload.pypi.org/legacy/
# build_dir: ./dist

# - name: Publish documentation
# uses: maxheld83/ghpages@v0.2.1
# with:
# build_dir: docs/_build/html
# target_branch: gh-pages
# committer_name: "GitHub Actions"
# committer_email: "
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
# NBIA Toolkit
- Packaged code to access the NBIA REST API

See Documentation at [NBIA-Toolkit Read The Docs](https://nbia-toolkit.readthedocs.io/en/latest/)

Wiki is empty for now:
See the [Wiki](https://github.com/jjjermiah/NBIA-toolkit/wiki) for more information.

# nbiatoolkit
Expand Down

0 comments on commit 5a285e8

Please sign in to comment.