Skip to content

try fixing pytest doctest-modules #35

try fixing pytest doctest-modules

try fixing pytest doctest-modules #35

Workflow file for this run

name: test and build docs
on: push
concurrency: test
env:
S3_HOST: ${{vars.S3_HOST}}
S3_BUCKET: ${{vars.S3_TEST_BUCKET}} # testing!
S3_FOLDER: ${{vars.S3_TEST_FOLDER}} # testing!
ZENODO_URL: ${{vars.ZENODO_TEST_URL}} # testing!
ZENODO_TEST_URL: ${{vars.ZENODO_TEST_URL}}
S3_ACCESS_KEY_ID: ${{secrets.S3_ACCESS_KEY_ID}}
S3_SECRET_ACCESS_KEY: ${{secrets.S3_SECRET_ACCESS_KEY}}
ZENODO_API_ACCESS_TOKEN: ${{secrets.ZENODO_TEST_API_ACCESS_TOKEN}} # testing!
ZENODO_TEST_API_ACCESS_TOKEN: ${{secrets.ZENODO_TEST_API_ACCESS_TOKEN}}
jobs:
initial-cleanup:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: "pip" # caching pip dependencies
- run: pip install .
- run: backoffice wipe --bucket "${{vars.S3_TEST_BUCKET}}" --prefix "${{vars.S3_TEST_FOLDER}}"
test-stage-wf:
needs: initial-cleanup
uses: ./.github/workflows/stage_call.yaml
with:
resource_id: ${{vars.TEST_PACKAGE_ID}} # testing!
package_url: ${{vars.TEST_PACKAGE_URL}} # testing!
S3_HOST: ${{vars.S3_HOST}}
S3_BUCKET: ${{vars.S3_TEST_BUCKET}} # testing!
S3_FOLDER: ${{vars.S3_TEST_FOLDER}}/ci # testing!
secrets: inherit
test-publish-wf:
needs: test-stage-wf
uses: ./.github/workflows/publish_call.yaml
with:
resource_id: ${{vars.TEST_PACKAGE_ID}} # testing!
stage_nr: 1
S3_HOST: ${{vars.S3_HOST}}
S3_BUCKET: ${{vars.S3_TEST_BUCKET}} # testing!
S3_FOLDER: ${{vars.S3_TEST_FOLDER}}/ci # testing!
ZENODO_URL: ${{vars.ZENODO_TEST_URL}} # testing!
secrets: inherit
test-backup-wf:
needs: test-publish-wf
uses: ./.github/workflows/backup_call.yaml
with:
S3_HOST: ${{vars.S3_HOST}}
S3_BUCKET: ${{vars.S3_TEST_BUCKET}} # testing!
S3_FOLDER: ${{vars.S3_TEST_FOLDER}}/ci # testing!
ZENODO_URL: ${{vars.ZENODO_TEST_URL}} # testing!
secrets: inherit
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.12"
cache: "pip" # caching pip dependencies
- run: pip install .[dev]
- run: black .
- run: pyright -p pyproject.toml
- run: pip uninstall . # leave only dependencies, so pytest doctest-modules imports local files and not from site-packages
- run: pytest
- name: export documentation
if: ${{ github.ref == 'ref/head/main' }}
run: pdoc . -o ./docs
- uses: actions/upload-pages-artifact@v3
if: ${{ github.ref == 'ref/head/main' }}
with:
path: docs/
deploy:
needs: build
if: ${{ github.ref == 'ref/head/main' }}
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4