Compare commits

...

3 commits

Author SHA1 Message Date
771993f999
feat: Add pypi auto publishing
Some checks are pending
website / build (push) Waiting to run
website / deploy (push) Blocked by required conditions
Publish python package to pypi and testpypi / Build distribution (push) Waiting to run
Publish python package to pypi and testpypi / Publish dist to pypi (push) Blocked by required conditions
Publish python package to pypi and testpypi / Test publishing to testpypi (push) Blocked by required conditions
2025-04-09 10:52:14 +02:00
2fb0608a87
doc: Add README badges 2025-04-09 10:47:25 +02:00
2f29054429
doc: Remove leftover footnote 2025-04-09 10:47:24 +02:00
3 changed files with 73 additions and 4 deletions

View file

@ -20,7 +20,7 @@ jobs:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.13'
python-version: '3.x'
- name: Install the latest version of uv
uses: astral-sh/setup-uv@v5

67
.github/workflows/release.yaml vendored Normal file
View file

@ -0,0 +1,67 @@
name: Publish python package to pypi and testpypi
on: push
jobs:
build:
name: Build distribution
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install the latest version of uv
uses: astral-sh/setup-uv@v5
- name: Build the wheel and source tarball
run: uv build
- name: Store dist packages
uses: actions/upload-artifact@v4
with:
name: python-package-distributions
path: dist/
publish-to-pypi:
name: Publish dist to pypi
runs-on: ubuntu-latest
if: startsWith(github.ref, 'refs/tags/')
needs:
- build
environment:
name: pypi
url: https://pypi.org/p/topen
permissions:
id-token: write
steps:
- name: Grab dist files
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/
- name: Send off to PyPi
uses: pypa/gh-action-pypi-publish@release/v1
publish-to-testpypi:
name: Test publishing to testpypi
runs-on: ubuntu-latest
needs:
- build
environment:
name: testpypi
url: https://test.pypi.org/p/topen
permissions:
id-token: write
steps:
- name: Grab dist files
uses: actions/download-artifact@v4
with:
name: python-package-distributions
path: dist/
- name: Send off to TestPyPi
uses: pypa/gh-action-pypi-publish@release/v1
with:
repository-url: https://test.pypi.org/legacy/

View file

@ -1,7 +1,9 @@
# Simple taskwarrior note management
[Docs](https://marty-oehme.github.io/topen)
[Pypi](https://pypi.org/project/topen)
[![Static Badge](https://img.shields.io/badge/pdoc-Docs-blue)](https://marty-oehme.github.io/topen)
[![PyPI - Version](https://img.shields.io/pypi/v/topen)](https://pypi.org/project/topen)
[![GitHub Release](https://img.shields.io/github/v/release/marty-oehme/topen)](https://github.com/marty-oehme/topen/releases/latest)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/marty-oehme/topen/release.yaml)
A script without bells and whistles.
Focuses on letting you quickly:
@ -15,7 +17,7 @@ Provide a taskwarrior task id or uuid and `topen` creates a new note file or let
you edit an existing one. Additionally it adds a small annotation to the task
to let you see that there exists a note file next time you view the task.
Should just work as-is without additional configuration in most modern taskwarrior setups.[^moderntw]
Should just work as-is without additional configuration in most modern taskwarrior setups.
Can be configured through environment variables or cli options, see below.