-
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.
- Loading branch information
1 parent
87a2ff0
commit c84c82c
Showing
3 changed files
with
131 additions
and
42 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,95 @@ | ||
| name: ci-cd | ||
|
|
||
| on: [push, pull_request] | ||
|
|
||
| jobs: | ||
| ci: | ||
| # Set up operating system | ||
| runs-on: ubuntu-latest | ||
|
|
||
| # Define job steps | ||
| steps: | ||
| - name: Set up Python | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: "3.11" | ||
|
|
||
| - name: Check-out repository | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install poetry | ||
| uses: snok/install-poetry@v1 | ||
|
|
||
| - name: Install package | ||
| run: poetry install | ||
|
|
||
| - name: Test with pytest | ||
| run: poetry run pytest tests/ --cov=datastructpy --cov-report=xml | ||
|
|
||
| - name: Use Codecov to track coverage | ||
| uses: codecov/codecov-action@v5 | ||
| with: | ||
| token: ${{ secrets.CODECOV_TOKEN }} | ||
| files: ./coverage.xml # coverage report | ||
|
|
||
| - name: Build documentation | ||
| run: poetry run make html --directory docs/ | ||
|
|
||
| cd: | ||
| permissions: | ||
| id-token: write | ||
| contents: write | ||
|
|
||
| # Only run this job if the "ci" job passes | ||
| needs: ci | ||
|
|
||
| # Only run this job if new work is pushed to "main" | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
|
|
||
| # Set up operating system | ||
| runs-on: ubuntu-latest | ||
|
|
||
| # Define job steps | ||
| steps: | ||
| - name: Set up Python | ||
| uses: actions/setup-python@v4 | ||
| with: | ||
| python-version: "3.11" | ||
|
|
||
| - name: Check-out repository | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Use Python Semantic Release to prepare release | ||
| id: release | ||
| uses: python-semantic-release/[email protected] | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Publish to TestPyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| if: steps.release.outputs.released == 'true' | ||
| with: | ||
| repository-url: https://test.pypi.org/legacy/ | ||
| password: ${{ secrets.TEST_PYPI_API_TOKEN }} | ||
|
|
||
| - name: Test install from TestPyPI | ||
| if: steps.release.outputs.released == 'true' | ||
| run: | | ||
| pip install \ | ||
| --index-url https://test.pypi.org/simple/ \ | ||
| --extra-index-url https://pypi.org/simple \ | ||
| datastructpy | ||
| - name: Publish to PyPI | ||
| uses: pypa/gh-action-pypi-publish@release/v1 | ||
| if: steps.release.outputs.released == 'true' | ||
| with: | ||
| password: ${{ secrets.PYPI_API_TOKEN }} | ||
|
|
||
| - name: Publish package distributions to GitHub Releases | ||
| uses: python-semantic-release/upload-to-gh-release@main | ||
| if: steps.release.outputs.released == 'true' | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} |
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,23 @@ | ||
| # .readthedocs.yaml | ||
| # Read the Docs configuration file | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
|
||
| # Required | ||
| version: 2 | ||
|
|
||
| # Set the OS, Python version and other tools you might need | ||
| build: | ||
| os: ubuntu-22.04 | ||
| tools: | ||
| python: "3.11" | ||
| jobs: | ||
| post_create_environment: | ||
| # Install poetry | ||
| # https://python-poetry.org/docs/#installing-manually | ||
| - pip install poetry | ||
| post_install: | ||
| - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install | ||
|
|
||
| # Build documentation in the "docs/" directory with Sphinx | ||
| sphinx: | ||
| configuration: docs/conf.py |