Python Semantic Release (PSR) provides an automated release mechanism determined by SemVer and Commit Message Conventions for your Git projects.

The purpose of this project is to detect what the next version of the project should be from parsing the latest commit messages. If the commit messages describe changes that would require a major, minor or patch version bump, PSR will automatically bump the version number accordingly. PSR, however, does not stop there but will help automate the whole release process. It will update the project code and distribution artifact, upload the artifact and post changelogs to a remotely hosted Version Control System (VCS).

The tool is designed to run inside of a CI/CD pipeline service, but it can also be run locally.

This project was originally inspired by the semantic-release project for JavaScript by Stephan Bönnemann, but the codebases have significantly deviated since then, as PSR as driven towards the goal of providing flexible changelogs and simple initial setup.

Read more about the setup and configuration in our :ref:`Getting Started Guide <inline-getting-started-guide>`.

.. toctree::
   :maxdepth: 1

   What's New <misc/psr_changelog>
   Concepts <concepts/index>
   CLI <api/commands>
   configuration/index
   upgrading/index
   misc/troubleshooting
   API <api/modules/modules>
   Contributing <contributing/index>
   View on GitHub <https://github.com/python-semantic-release/python-semantic-release>