Python Template is a template repository that provides CI/CD workflows for Python applications.
Choose george-lim/python-template
as the template when creating a new repository.
Python Template provides a README.md
, LICENSE
, .gitignore
, and two workflows for GitHub Actions.
There are no examples to provide for Python Template.
There are two workflows in this repository. Each workflow supports manual triggering.
The CI
workflow is automatically triggered whenever there is push activity in main
or pull request activity towards main
. It has two jobs:
- Lint the codebase with GitHub's Super-Linter.
- Run unit tests with
pytest
, generate a code coverage report, and upload the report to Codecov.
The CD
workflow is automatically triggered whenever there is a tag pushed to the repository. It has one job:
- Create a GitHub release with the tag.
You will need to authorize Codecov with your GitHub account in order to upload code coverage reports.
Follow the Codecov GitHub Action to see how to configure the action for private repositories.