From 43294438f96036955135dfbaae09d43fd644ca9d Mon Sep 17 00:00:00 2001 From: codejedi365 Date: Tue, 24 Sep 2024 19:59:55 -0600 Subject: [PATCH 1/3] chore(gha): update action details for marketplace publishing --- action.yml | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/action.yml b/action.yml index 13ea3593b..dd3c1547f 100644 --- a/action.yml +++ b/action.yml @@ -1,7 +1,10 @@ --- name: Python Semantic Release -description: Automatic Semantic Versioning for Python projects +description: Automated Releases via SemVer and Commit Message Conventions + +branding: + color: orange inputs: root_options: @@ -103,14 +106,14 @@ outputs: description: | "true" if a release was made, "false" otherwise - version: - description: | - The newly released version if one was made, otherwise the current version - tag: description: | The Git tag corresponding to the version output + version: + description: | + The newly released version if one was made, otherwise the current version + runs: using: docker image: Dockerfile From 92dede679a402e31e5476e5d375c756063b742f5 Mon Sep 17 00:00:00 2001 From: codejedi365 Date: Fri, 27 Sep 2024 00:59:24 -0600 Subject: [PATCH 2/3] docs(homepage): re-structure homepage to be separate from project readme --- docs/index.rst | 52 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 51 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 210d820a9..b51b47128 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,4 +1,54 @@ -.. include:: ../README.rst +Python Semantic Release +*********************** + +|Ruff| |Test Status| |PyPI Version| |conda-forge version| |Read the Docs Status| |Pre-Commit Enabled| + +Automatic Semantic Versioning for Python projects. This is a Python +implementation of `semantic-release`_ for JS by Stephan Bönnemann. If +you find this topic interesting you should check out his `talk from +JSConf Budapest`_. + +The general idea is to be able to detect what the next version of the +project should be based on the commits. This tool will use that to +automate the whole release, upload to an artifact repository and post changelogs to +GitHub. You can run the tool on a CI service, or just run it locally. + +Installation +============ + +:: + + python3 -m pip install python-semantic-release + semantic-release --help + +Python Semantic Release is also available from `conda-forge`_ or as a `GitHub Action`_. +Read more about the setup and configuration in our `getting started guide`_. + +.. _semantic-release: https://github.com/semantic-release/semantic-release +.. _talk from JSConf Budapest: https://www.youtube.com/watch?v=tc2UgG5L7WM +.. _getting started guide: https://python-semantic-release.readthedocs.io/en/latest/#getting-started +.. _GitHub Action: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html +.. _conda-forge: https://anaconda.org/conda-forge/python-semantic-release + +.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/main.yml?branch=master&label=Test%20Status&logo=github + :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/main.yml + :alt: test-status +.. |PyPI Version| image:: https://img.shields.io/pypi/v/python-semantic-release?label=PyPI&logo=pypi + :target: https://pypi.org/project/python-semantic-release/ + :alt: pypi +.. |conda-forge Version| image:: https://img.shields.io/conda/vn/conda-forge/python-semantic-release?logo=anaconda + :target: https://anaconda.org/conda-forge/python-semantic-release + :alt: conda-forge +.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=Read%20the%20Docs + :target: https://python-semantic-release.readthedocs.io/en/latest/ + :alt: docs +.. |Pre-Commit Enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit + :target: https://github.com/pre-commit/pre-commit + :alt: pre-commit +.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Ruff + Documentation Contents ====================== From cc6c72be280d7eb8ae8f8b543df376df769ce7c6 Mon Sep 17 00:00:00 2001 From: codejedi365 Date: Fri, 27 Sep 2024 01:00:34 -0600 Subject: [PATCH 3/3] docs(README): simplify README to point at official docs --- README.rst | 54 +++++++++++++----------------------------------------- 1 file changed, 13 insertions(+), 41 deletions(-) diff --git a/README.rst b/README.rst index 70167f553..c8fdd9f14 100644 --- a/README.rst +++ b/README.rst @@ -1,50 +1,22 @@ Python Semantic Release *********************** -|Ruff| |Test Status| |PyPI Version| |conda-forge version| |Read the Docs Status| |Pre-Commit Enabled| +*Automating Releases via SemVer and Commit Message Conventions* -Automatic Semantic Versioning for Python projects. This is a Python -implementation of `semantic-release`_ for JS by Stephan Bönnemann. If -you find this topic interesting you should check out his `talk from -JSConf Budapest`_. +---- -The general idea is to be able to detect what the next version of the -project should be based on the commits. This tool will use that to -automate the whole release, upload to an artifact repository and post changelogs to -GitHub. You can run the tool on a CI service, or just run it locally. +The official documentation for Python Semantic Release can be found at +`python-semantic-release.readthedocs.io`_. -Installation -============ +GitHub Action +============= -:: +When using the Python Semantic Release GitHub Action, it executes the command +``semantic-release version`` using `python-semantic-release`_. - python3 -m pip install python-semantic-release - semantic-release --help +The usage information and examples for this GitHub Action is available under +the `GitHub Actions section`_ of `python-semantic-release.readthedocs.io`_. -Python Semantic Release is also available from `conda-forge`_ or as a `GitHub Action`_. -Read more about the setup and configuration in our `getting started guide`_. - -.. _semantic-release: https://github.com/semantic-release/semantic-release -.. _talk from JSConf Budapest: https://www.youtube.com/watch?v=tc2UgG5L7WM -.. _getting started guide: https://python-semantic-release.readthedocs.io/en/latest/#getting-started -.. _GitHub Action: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html -.. _conda-forge: https://anaconda.org/conda-forge/python-semantic-release - -.. |Test Status| image:: https://img.shields.io/github/actions/workflow/status/python-semantic-release/python-semantic-release/main.yml?branch=master&label=Test%20Status&logo=github - :target: https://github.com/python-semantic-release/python-semantic-release/actions/workflows/main.yml - :alt: test-status -.. |PyPI Version| image:: https://img.shields.io/pypi/v/python-semantic-release?label=PyPI&logo=pypi - :target: https://pypi.org/project/python-semantic-release/ - :alt: pypi -.. |conda-forge Version| image:: https://img.shields.io/conda/vn/conda-forge/python-semantic-release?logo=anaconda - :target: https://anaconda.org/conda-forge/python-semantic-release - :alt: conda-forge -.. |Read the Docs Status| image:: https://img.shields.io/readthedocs/python-semantic-release?label=Read%20the%20Docs&logo=Read%20the%20Docs - :target: https://python-semantic-release.readthedocs.io/en/latest/ - :alt: docs -.. |Pre-Commit Enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit - :target: https://github.com/pre-commit/pre-commit - :alt: pre-commit -.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json - :target: https://github.com/astral-sh/ruff - :alt: Ruff +.. _python-semantic-release: https://pypi.org/project/python-semantic-release/ +.. _python-semantic-release.readthedocs.io: https://python-semantic-release.readthedocs.io/en/latest/ +.. _GitHub Actions section: https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/github-actions.html