From 6a46b934f74f7dcfd7903399f1ef064ac44496af Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Mon, 9 Feb 2026 21:21:50 -0500 Subject: Add job to update README --- .builds/readme.yml | 20 ++++++++++++++++++++ README.rst | 29 ++++++++++++++++------------- scripts/readme.sh | 9 +++++++++ 3 files changed, 45 insertions(+), 13 deletions(-) create mode 100644 .builds/readme.yml create mode 100755 scripts/readme.sh diff --git a/.builds/readme.yml b/.builds/readme.yml new file mode 100644 index 0000000..cdb63d9 --- /dev/null +++ b/.builds/readme.yml @@ -0,0 +1,20 @@ +image: alpine/3.23 +oauth: git.sr.ht/REPOSITORIES:RW git.sr.ht/PROFILE:RO +submitter: + git.sr.ht: + enabled: true + allow-refs: + - refs/heads/main +packages: + - hut + - pandoc-cli +sources: + - https://git.sr.ht/~eugenetriguba/lirc +triggers: + - action: email + condition: failure + to: builds@eugenetriguba.com +tasks: + - update-readme: | + cd lirc + ./scripts/readme.sh diff --git a/README.rst b/README.rst index 6f9feff..6c23a07 100644 --- a/README.rst +++ b/README.rst @@ -1,24 +1,27 @@ LIRC Python Package =================== -.. image:: https://img.shields.io/pypi/pyversions/lirc + +|pyversions| |version| |docs| |build| |contributing| |license| |platform| + +.. |pyversions| image:: https://img.shields.io/pypi/pyversions/lirc :target: https://www.python.org/downloads/ :alt: Python Version -.. image:: https://img.shields.io/pypi/v/lirc +.. |version| image:: https://img.shields.io/pypi/v/lirc :target: https://pypi.org/project/lirc/ :alt: Project Version -.. image:: https://readthedocs.org/projects/lirc/badge/?version=latest - :target: https://lirc.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status -.. image:: https://builds.sr.ht/~eugenetriguba/lirc/commits/main/lint-and-test.yml.svg - :target: https://builds.sr.ht/~eugenetriguba/lirc/commits/main/lint-and-test.yml - :alt: builds.sr.ht status -.. image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg - :target: https://github.com/eugenetriguba/lirc/issues - :alt: Contributing -.. image:: https://img.shields.io/pypi/l/lirc +.. |docs| image:: https://readthedocs.org/projects/lirc/badge/?version=latest + :target: https://lirc.readthedocs.io/en/latest/?badge=latest + :alt: Documentation Status +.. |build| image:: https://builds.sr.ht/~eugenetriguba/lirc/commits/main/lint-and-test.yml.svg + :target: https://builds.sr.ht/~eugenetriguba/lirc/commits/main/lint-and-test.yml + :alt: builds.sr.ht status +.. |contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg + :target: https://github.com/eugenetriguba/lirc/issues + :alt: Contributing +.. |license| image:: https://img.shields.io/pypi/l/lirc :target: https://pypi.python.org/pypi/lirc/ :alt: License -.. image:: https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-%23F9F9F9 +.. |platform| image:: https://img.shields.io/badge/platform-linux%20%7C%20macos%20%7C%20windows-%23F9F9F9 :target: https://lirc.readthedocs.io/en/latest/installation.html :alt: Platform Support diff --git a/scripts/readme.sh b/scripts/readme.sh new file mode 100755 index 0000000..5f3b264 --- /dev/null +++ b/scripts/readme.sh @@ -0,0 +1,9 @@ +#!/bin/sh +set -e + +main() { + pandoc --from rst --to html README.rst >README.html + hut git update --readme README.html +} + +main "$@" -- cgit v1.2.3