https://github.com/k2bd/action-python-poetry

Template repo to quickly make a tested and documented GitHub action in Python with Poetry
https://github.com/k2bd/action-python-poetry

actions github-actions poetry poetry-python python python3 template templates

Last synced: 2 days ago
JSON representation

Template repo to quickly make a tested and documented GitHub action in Python with Poetry

• Host: GitHub
• URL: https://github.com/k2bd/action-python-poetry
• Owner: k2bd
• License: mit
• Created: 2021-12-04T12:23:44.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-20T16:02:53.000Z (8 months ago)
• Last Synced: 2024-08-01T16:41:40.021Z (3 months ago)
• Topics: actions, github-actions, poetry, poetry-python, python, python3, template, templates
• Language: Python
• Homepage:
• Size: 21.5 KB
• Stars: 91
• Watchers: 1
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

• my-awesome-github-stars - k2bd/action-python-poetry - Template repo to quickly make a tested and documented GitHub action in Python with Poetry (Python)

README

        
# Python + Poetry GitHub Action Template

## Getting started from the template

1. Rename the `src/action_python_poetry` package.

1. Globally replace instances of `action-python-poetry` and `action_python_poetry` with your project and package name.

1. If your repo is private, set it up on [CodeCov](https://app.codecov.io/) and add a codecov token to your repo under the `CODECOV_TOKEN` secret.

1. Create and test your action. `__main__.py` in your package will be executed when the action is run. The environment variables your tests use can be [set in `pyproject.toml`](https://github.com/k2bd/action-python-poetry/blob/694756b8ff6656f8e1a9a4a141f293100f55229d/pyproject.toml#L39-L41) and/or managed in test fixtures.

1. Update `action.yml`, `README.md`, and `.github/workflows/test-action.yml` to reflect your action's specification.

1. Update `LICENSE.md` as appropriate, making sure to retain the original copyright and permissions notices in your distribution according to the MIT license that this template is distributed under.

1. Remove this section from `README.md`.

1. Happy hacking!

### Like this template?

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png)](https://www.buymeacoffee.com/k2bd)

## Quickstart

```yml

name: Run Action

on:

  workflow_dispatch:

jobs:

  action-python-poetry:

    runs-on: ubuntu-latest

    steps:

      - uses: k2bd/action-python-poetry@v1

        with:

          helloName: k2bd

          repeats: 3

```

## Action Specification

### `helloName`

**Required**

The name of the person to say hello to

### `repeats`

*Optional* - default 1

Number of times to say hello to this person

## Developing

Install [Poetry](https://python-poetry.org/) and `poetry install` the project

### Useful Commands

Note: if Poetry is managing a virtual environment for you, you may need to use `poetry run poe` instead of `poe`

- `poe autoformat` - Autoformat code

- `poe lint` - Linting

- `poe test` - Run Tests

### Testing the action

The action can be tested locally by building the Dockerfile, e.g.

```sh

docker run -e INPUT_HELLONAME=k2bd -e INPUT_REPEATS=2 $(docker build -q .)

```

Additionally, there is a manual invocation action on the repo called "Test Action" that can be used to invoke the repo's version of the action from the Actions tab of the repo.

### Releasing

Release a new version by creating a new annotated semver tag e.g. `git tag -a v1.2.3 -m "Release version 1.2.3"` and pushing it (`git push --tags`). Then create a new release from that tag in GitHub.

There is an autoversioning action that keeps major version tags (`v1`, `v2`, ...) and `latest` up-to-date when a new release is published.