python-semantic-release · codejedi365 · Sep 27, 2024 · Sep 25, 2024 · Sep 27, 2024 · Sep 27, 2024
diff --git 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
diff --git a/action.yml b/action.yml
@@ -1,7 +1,10 @@
 ---
 name: Python Semantic Release
 
-description: Automatic Semantic Versioning for Python project
8000
s
+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
diff --git 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
 ======================