-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #83 from biomarkersParkinson/main
Various documentation updates and other updates
- Loading branch information
Showing
30 changed files
with
2,168 additions
and
2,342 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | ||
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | ||
|
|
||
| name: Build and test | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ main ] | ||
| pull_request: | ||
| branches: [ main ] | ||
| workflow_call: | ||
| outputs: | ||
| version: | ||
| description: "The version retrieved from the pyproject.toml file." | ||
| value: ${{ jobs.build-and-test.outputs.version }} | ||
|
|
||
| jobs: | ||
| build-and-test: | ||
|
|
||
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| python-version: ['3.10'] | ||
| outputs: | ||
| version: ${{ steps.get_version.outputs.version }} | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Set up Python ${{ matrix.python-version }} | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ matrix.python-version }} | ||
|
|
||
| # Get the version from pyproject.toml | ||
| # This will be used to tag the release in the publishing workflow | ||
| - name: Install toml package | ||
| run: pip install toml | ||
| - name: Get version from pyproject.toml | ||
| id: get_version | ||
| run: | | ||
| VERSION=$(python -c "import toml; print(toml.load('pyproject.toml')['tool']['poetry']['version'])") | ||
| echo Version: $VERSION | ||
| echo "version=$VERSION" >> $GITHUB_OUTPUT | ||
| # Installation | ||
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install poetry | ||
| poetry install | ||
| # Testing and checking | ||
| - name: Test with pytest | ||
| run: | | ||
| poetry run pytest | ||
| - name: Type check | ||
| run: | | ||
| poetry run pytype . | ||
| # Build the package | ||
| - name: Build the package | ||
| run: | | ||
| poetry build | ||
| - name: Archive build artifacts | ||
| uses: actions/upload-artifact@v4 | ||
| if: github.ref == 'refs/heads/release' | ||
| with: | ||
| name: build-artifacts | ||
| path: dist/ | ||
|
|
||
| # Build the docs | ||
| - name: Build the docs | ||
| run: | | ||
| poetry run make html --directory docs | ||
| - name: Archive documentation | ||
| uses: actions/upload-artifact@v4 | ||
| if: github.ref == 'refs/heads/release' | ||
| with: | ||
| name: docs-html | ||
| path: docs/build/html/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| # Sources: | ||
| # https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/#workflow-definition | ||
| # https://github.com/marketplace/actions/pypi-publish | ||
|
|
||
| name: Publish package and docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: [ release ] | ||
|
|
||
| jobs: | ||
| build-and-test: | ||
| uses: ./.github/workflows/build-and-test.yml | ||
|
|
||
| create-tag: | ||
| name: Create Git Tag | ||
| needs: build-and-test | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Create Git Tag | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| VERSION: ${{ needs.build-and-test.outputs.version }} | ||
| run: | | ||
| git config --global user.name 'github-actions' | ||
| git config --global user.email '[email protected]' | ||
| git tag "v${VERSION}" | ||
| git push origin "v${VERSION}" | ||
| publish-to-pypi: | ||
| name: Publish to PyPI | ||
| needs: [build-and-test, create-tag] | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: pypi | ||
| url: https://pypi.org/p/tsdf | ||
| permissions: | ||
| id-token: write # mandatory for trusted publishing | ||
|
|
||
| steps: | ||
| - name: Download all the dists | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: build-artifacts | ||
| path: dist/ | ||
| - name: Publish distribution 📦 to PyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
|
|
||
|
|
||
| github-release: | ||
| name: Sign distribution and create GitHub release | ||
| needs: [build-and-test, create-tag] | ||
| runs-on: ubuntu-latest | ||
|
|
||
| permissions: | ||
| contents: write # mandatory for making GitHub Releases | ||
| id-token: write # mandatory for sigstore | ||
|
|
||
| steps: | ||
| - name: Download all the dists | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: build-artifacts | ||
| path: dist/ | ||
|
|
||
| - name: Sign the dists with Sigstore | ||
| uses: sigstore/[email protected] | ||
| with: | ||
| inputs: >- | ||
| ./dist/*.tar.gz | ||
| ./dist/*.whl | ||
| - name: Create GitHub Release | ||
| env: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| VERSION: ${{ needs.build-and-test.outputs.version }} | ||
| run: >- | ||
| gh release create | ||
| "v${VERSION}" | ||
| --repo '${{ github.repository }}' | ||
| --notes "" | ||
| - name: Upload artifact signatures to GitHub Release | ||
| env: | ||
| GITHUB_TOKEN: ${{ github.token }} | ||
| VERSION: ${{ needs.build-and-test.outputs.version }} | ||
| # Upload to GitHub Release using the `gh` CLI. | ||
| # `dist/` contains the built packages, and the | ||
| # sigstore-produced signatures and certificates. | ||
| run: >- | ||
| gh release upload | ||
| "v${VERSION}" dist/** | ||
| --repo '${{ github.repository }}' | ||
| publish-docs: | ||
| name: Publish documentation | ||
| needs: build-and-test | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| steps: | ||
| - name: Download the documentation | ||
| uses: actions/download-artifact@v4 | ||
| with: | ||
| name: docs-html | ||
| path: docs/ | ||
| - name: Deploy | ||
| uses: peaceiris/actions-gh-pages@v3 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| publish_dir: docs/ |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,7 +69,7 @@ instance/ | |
| .scrapy | ||
|
|
||
| # Sphinx documentation | ||
| docs/_build/ | ||
| docs/build/ | ||
|
|
||
| # PyBuilder | ||
| target/ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Minimal makefile for Sphinx documentation | ||
| # | ||
|
|
||
| # You can set these variables from the command line, and also | ||
| # from the environment for the first two. | ||
| SPHINXOPTS ?= | ||
| SPHINXBUILD ?= sphinx-build | ||
| SOURCEDIR = . | ||
| BUILDDIR = build | ||
|
|
||
| # Put it first so that "make" without argument is like "make help". | ||
| help: | ||
| @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
|
||
| .PHONY: help Makefile | ||
|
|
||
| # Catch-all target: route all unknown targets to Sphinx using the new | ||
| # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
| %: Makefile | ||
| @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.