From 5a285e894d7611a390604582249ce6874ddc8c6e Mon Sep 17 00:00:00 2001 From: Jermiah Date: Mon, 20 Nov 2023 17:33:49 +0000 Subject: [PATCH] Update GitHub Actions workflow and add documentation generation --- .github/workflows/main.yml | 51 +++++++++++++++++++++++++++++++++++++- README.md | 3 +++ 2 files changed, 53 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index a1be926..186caeb 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -3,7 +3,7 @@ name: Unit Tests on: [push] jobs: - build: + Continuous-Integration: runs-on: ${{ matrix.os }} strategy: matrix: @@ -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: " \ No newline at end of file diff --git a/README.md b/README.md index 2757cc7..d9074b4 100644 --- a/README.md +++ b/README.md @@ -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