Skip to content

Commit

Permalink
docs(readme): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
matteo4diani committed Aug 13, 2023
1 parent 02036a8 commit e6fd1d9
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
![Tests](https://github.com/matteo4diani/poetry-semantic-release-test/actions/workflows/test.yml/badge.svg)
![Release](https://github.com/matteo4diani/poetry-semantic-release/actions/workflows/release.yml/badge.svg)

# Poetry Semantic Release
A composite GitHub Action to release simple Python packages on GitHub and PyPI following semantic versioning and conventional commits.
# semantic-poetry 🪶
[semantic-poetry](https://github.com/marketplace/actions/semantic-poetry) is a GitHub Action that automates the release of [poetry](https://python-poetry.org/)-based Python packages on GitHub and PyPI following [semantic versioning](https://semver.org) and [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) standards.

## Usage

This action automates [semantic versioning](https://semver.org) and distribution of Python projects by leveraging [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary).

To use it in your CI:
1. Generate a PyPI Token from PyPI: https://pypi.org/help/#apitoken
2. Set your PyPI Token as a repository secret named `PYPI_TOKEN`: https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository
Expand Down

0 comments on commit e6fd1d9

Please sign in to comment.