Skip to content

Commit

Permalink
ci: add release-please
Browse files Browse the repository at this point in the history
Adds release please as a tool to automatically create
PR's in GitHub incrementing python package versions,
as well as building and publishing packages to PyPi
on new releases.
  • Loading branch information
mariugul committed Aug 28, 2024
1 parent a0d5d81 commit 971c788
Show file tree
Hide file tree
Showing 4 changed files with 87 additions and 1 deletion.
73 changes: 73 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
on:
push:
branches:
- main

name: release-please

permissions:
contents: write
pull-requests: write


jobs:
release-please:
runs-on: ubuntu-latest
outputs:
release_created: ${{ steps.release.outputs.release_created }}
steps:
- name: Release Please
id: release
uses: googleapis/release-please-action@v4
with:
token: ${{ secrets.RELEASE_PLEASE_TOKEN }}

build-and-publish:
runs-on: ubuntu-latest
needs: release-please
if: ${{ needs.release-please.outputs.release_created == 'true' }}
permissions:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
environment:
name: pypi
url: https://pypi.org/p/pikaraoke
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.9'

- name: Cache Poetry Install
id: cache-poetry
uses: actions/cache@v4
with:
path: |
/opt/poetry
~/.cache/pypoetry
.venv
key: ${{ runner.os }}-poetry-${{ hashFiles('**/poetry.lock') }}-${{ hashFiles('**/pyproject.toml')
}}

- name: Install Poetry
if: steps.cache-poetry.outputs.cache-hit != 'true'
run: |
export POETRY_HOME=/opt/poetry
python3 -m venv $POETRY_HOME
$POETRY_HOME/bin/pip install poetry==1.8.2
$POETRY_HOME/bin/poetry --version
- name: Add Poetry to PATH
run: echo "/opt/poetry/bin" >> $GITHUB_PATH

- name: Install Package
run: poetry install --no-interaction --no-ansi

- name: Build Package
run: poetry build

- name: Publish Python 🐍 distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
Empty file added .release-please-manifest.json
Empty file.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "pikaraoke"
version = "1.0.0"
version = "1.3.0"
description = "Youtube-based Karaoke machine for Raspberry Pi, OSX, Windows, and Linux"
authors = ["Vic Wong"]

Expand Down
13 changes: 13 additions & 0 deletions release-please-config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
"packages": {
".": {
"package-name": "pikaraoke",
"release-type": "python",
"include-component-in-tag": false,
"include-v-in-tag": false,
"changelog-path": "pikaraoke/CHANGELOG.md",
"version-file": "pikaraoke/version.py"
}
}
}

0 comments on commit 971c788

Please sign in to comment.