https://github.com/open-turo/actions-python

GitHub Actions for Python repositories
https://github.com/open-turo/actions-python

action actions gha github py python

Last synced: about 8 hours ago
JSON representation

GitHub Actions for Python repositories

• Host: GitHub
• URL: https://github.com/open-turo/actions-python
• Owner: open-turo
• License: mit
• Created: 2022-01-28T02:14:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-10T18:51:57.000Z (2 months ago)
• Last Synced: 2024-09-10T21:08:41.603Z (2 months ago)
• Topics: action, actions, gha, github, py, python
• Homepage:
• Size: 590 KB
• Stars: 3
• Watchers: 8
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `open-turo/actions-python`

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

[![Release](https://img.shields.io/github/v/release/open-turo/actions-python)](https://github.com/open-turo/actions-python/releases/)

[![Tests pass/fail](https://img.shields.io/github/workflow/status/open-turo/actions-python/CI)](https://github.com/open-turo/actions-python/actions/)

[![License](https://img.shields.io/github/license/open-turo/actions-python)](./LICENSE)

[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/dwyl/esta/issues)

[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

[![Conventional commits](https://img.shields.io/badge/conventional%20commits-1.0.2-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

[![Join us!](https://img.shields.io/badge/Turo-Join%20us%21-593CFB.svg)](https://turo.com/jobs)

## Actions

### action: [`lint`](./lint)

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

See usage [here](./lint/README.md#usage).

Documentation is found [here](./lint/README.md).

### action: [`test`](./test)

Test will run tests in the consumer repository using [pytest](https://github.com/pytest-dev/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](./test/README.md#usage).

Documentation is found [here](./test/README.md).

### action: [`release`](./release)

Release will optionally checkout the consumer repository and attempt a [Semantic Release](https://semantic-release.gitbook.io/semantic-release/usage/configuration) using the root level configuration file (e.g. .releaserc.json) indicating branches and plugins to use to facilitate the release.

See usage [here](./release/README.md#usage).

Documentation is found [here](./release/README.md).

## 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](https://github.com/open-turo/contributions) for guidelines on how to contribute to this project.