Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 2.46 KB

README.md

File metadata and controls

46 lines (27 loc) · 2.46 KB

open-turo/actions-python

GitHub Action for python based repositories. It uses pip as package manager.

Release Tests pass/fail License Contributions welcome semantic-release: angular Conventional commits Code style: black Join us!

Actions

action: lint

Lint will run pre-commit linters against the consumer repository, optionally checking out to to the consumer repository.

See usage here.

Documentation is found here.

action: test

Test will run tests in the consumer repository using pytest. This action will also check out the repository if checkout-repo is passed, as well as pip install .[dev] and pip install .[test] for dependencies.

See usage here.

Documentation is found here.

action: release

Release will optionally checkout the consumer repository and attempt a Semantic Release using the root level configuration file (e.g. .releaserc.json) indicating branches and plugins to use to facilitate the release.

See usage here.

Documentation is found here.

Get Help

Each Action has a detailed README for how to use it as referenced above. Please review Issues, post new Issues against this repository as needed.

Contributions

Please see here for guidelines on how to contribute to this project.