add py.typed marker for type checking
#50
Workflow file for this run
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
| name: Tests | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| jobs: | |
| self-test: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.x" | |
| - name: install cookiecutter | |
| run: python -m pip install cookiecutter | |
| # we need the git config setup here to make sure the subsequent git commit in each test works | |
| - name: setup fake git committer | |
| run: | | |
| git config --global user.email "fake@example.com" | |
| git config --global user.name "fake" | |
| - name: run template (default) | |
| run: | | |
| cookiecutter --no-input -o /tmp . | |
| [[ -d /tmp/python-project/src/python_project ]] || { >&2 echo "not generated?"; exit 1; } | |
| cd /tmp/python-project | |
| git init . && git add . && git commit -m "Initial commit" | |
| make dev | |
| make reformat | |
| git diff --exit-code || { >&2 echo "please reformat"; exit 1; } | |
| make lint | |
| make test | |
| make package | |
| make doc | |
| cd .. && rm -rf /tmp/python-project | |
| - name: run template (no entry point) | |
| run: | | |
| cookiecutter --no-input -o /tmp . entry_point='' | |
| [[ ! -f /tmp/python-project/python_project/__main__.py ]] || { >&2 echo "not expecting main"; exit 1; } | |
| cd /tmp/python-project | |
| git init . && git add . && git commit -m "Initial commit" | |
| make dev | |
| make reformat | |
| git diff --exit-code || { >&2 echo "please reformat"; exit 1; } | |
| make lint | |
| make test | |
| make package | |
| make doc | |
| cd .. && rm -rf /tmp/python-project | |
| - name: run template (namespace) | |
| run: | | |
| cookiecutter --no-input -o /tmp . project_namespace_import=tob.r_and_e | |
| [[ -d /tmp/tob-r-and-e-python-project/src/tob/r_and_e/python_project ]] || { >&2 echo "not generated?"; exit 1; } | |
| cd /tmp/tob-r-and-e-python-project | |
| git init . && git add . && git commit -m "Initial commit" | |
| make dev | |
| make reformat | |
| git diff --exit-code || { >&2 echo "please reformat"; exit 1; } | |
| make lint | |
| make test | |
| make package | |
| make doc | |
| cd .. && rm -rf /tmp/tob-r-and-e-python-project | |
| - name: run template (namespace, short slug) | |
| run: | | |
| cookiecutter --no-input -o /tmp . project_namespace_import=tob.r_and_e "project_name=Bit Trails" project_slug=bit-trails | |
| [[ -d /tmp/bit-trails/src/tob/r_and_e/bit_trails ]] || { >&2 echo "not generated?"; exit 1; } | |
| cd /tmp/bit-trails | |
| git init . && git add . && git commit -m "Initial commit" | |
| make dev | |
| make reformat | |
| git diff --exit-code || { >&2 echo "please reformat"; exit 1; } | |
| make lint | |
| make test | |
| make package | |
| make doc | |
| cd .. && rm -rf /tmp/bit-trails | |
| - name: run template (no docs) | |
| run: | | |
| cookiecutter --no-input -o /tmp . documentation='none' | |
| [[ -d /tmp/python-project/src/python_project ]] || { >&2 echo "not generated?"; exit 1; } | |
| [[ ! -f /tmp/python-project/.github/workflows/docs.yml ]] || { >&2 echo "not expecting docs.yml"; exit 1; } | |
| cd /tmp/python-project | |
| git init . && git add . && git commit -m "Initial commit" | |
| make dev | |
| make reformat | |
| git diff --exit-code || { >&2 echo "please reformat"; exit 1; } | |
| make lint | |
| make test | |
| make package | |
| make doc | |
| cd .. && rm -rf /tmp/python-project |