Skip to content
This repository has been archived by the owner on Jun 20, 2023. It is now read-only.

george-lim/python-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Python Template

releases ci codecov license

Python Template is a template repository that provides CI/CD workflows for Python applications.

Usage

Choose george-lim/python-template as the template when creating a new repository.

Features

Python Template provides a README.md, LICENSE, .gitignore, and two workflows for GitHub Actions.

Examples

There are no examples to provide for Python Template.

CI/CD

Pipeline

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:

  1. Lint the codebase with GitHub's Super-Linter.
  2. 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:

  1. Create a GitHub release with the tag.

Codecov

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.