-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from ewjoachim/change-versionning-system
- Loading branch information
Showing
3 changed files
with
74 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
name: Release | ||
|
||
on: | ||
workflow_dispatch: | ||
inputs: | ||
tag: | ||
description: "Tag to release" | ||
required: true | ||
type: string | ||
|
||
jobs: | ||
release: | ||
name: Release | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Install poetry | ||
run: pipx install poetry | ||
|
||
- uses: actions/setup-python@v5 | ||
with: | ||
cache: "poetry" | ||
|
||
- run: poetry install | ||
|
||
- run: poetry version "${{ github.event.inputs.tag }}" | ||
|
||
- run: git commit -am "Release ${{ github.event.inputs.tag }}" | ||
env: | ||
GIT_AUTHOR_NAME: "GitHub Actions" | ||
GIT_AUTHOR_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com" | ||
GIT_COMMITTER_NAME: "GitHub Actions" | ||
GIT_COMMITTER_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com" | ||
|
||
- run: git push origin | ||
|
||
- run: > | ||
gh release create "${{ github.event.inputs.tag }}" | ||
--title "${{ github.event.inputs.tag }}" | ||
--generate-notes | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Contributing | ||
|
||
Contributions are welcome! The project is quite small so feel free to | ||
familiarize yourself with the codebase and open an issue or a pull request. | ||
Before doing anything important, feel free to open an issue to discuss it. | ||
|
||
All interactions are required to follow the | ||
[Code of Conduct](CODE_OF_CONDUCT.md) which sets rules for the community. | ||
|
||
## Development | ||
|
||
The project uses [Poetry](https://python-poetry.org/), | ||
[pre-commit](https://pre-commit.com/), and | ||
[pytest](https://docs.pytest.org/en/stable/). | ||
|
||
```console | ||
$ poetry install | ||
$ pre-commit install | ||
$ poetry run pytest | ||
``` | ||
|
||
If you have any questions, feel free to ask them in the issues. | ||
|
||
# Internal documentation | ||
|
||
## Releasing | ||
|
||
Launch the `Release`worfklow with the desired tag. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters