<commit_before>Releasing
=========

Release are triggered by creating a tag ``trigger-x.y.z`` and pushing it to GitHub.
The release process removes the tag and replaces it with a version tag ``x.y.z``.
While release the ``news/*`` files are turned automatically into a nicely formatted ``CHANGES.rst``.
If on ``master`` branch the documentation on GH-pages will be updated too.

The steps for generating an automated release are:

- Edit ``setup.cfg`` and check the the version number. Minor was already increased after last release and a ``dev0`` was appended.
    - follow `PEP440 <https://www.python.org/dev/peps/pep-0440/>`_ and
    - follow `Semantic Versioning 2 <https://semver.org/>`_
    - check ``/news`` directory for feature and/or breaking changes and increase minor or major version number if needed (and not already done) in ``setup.cfg``.
    - keep the ``.dev0`` postfix, the release process will take care of it.
- ``git tag trigger-x.y.z`` the release (with ``x.y.z`` the release number).
    - technical the tag name is irrelevant for the release, but we agree to mirror the version number and prefix with ``trigger-``.
    - Push to master branch (final release) or to a prerelease/release test branch for alpha.
    - Make sure to do ``git push --tags``
- Travis will then release to `PyPI <https://pypi.org/project/Authomatic/#history>`_ as ``bdist_wheel`` and ``sdist`` (egg).
- After deployment the `Authomatic documentation <https://authomatic.github.io/authomatic/>`_ will get build and updated on GitHub Pages
  (only tags on master branch).<commit_msg>at the moment master only<commit_after>Releasing
=========

Release are triggered by creating a tag ``trigger-x.y.z`` and pushing it to GitHub.
The release process removes the tag and replaces it with a version tag ``x.y.z``.
While release the ``news/*`` files are turned automatically into a nicely formatted ``CHANGES.rst``.
If on ``master`` branch the documentation on GH-pages will be updated too.

The steps for generating an automated release are:

- Edit ``setup.cfg`` and check the the version number. Minor was already increased after last release and a ``dev0`` was appended.
    - follow `PEP440 <https://www.python.org/dev/peps/pep-0440/>`_ and
    - follow `Semantic Versioning 2 <https://semver.org/>`_
    - check ``/news`` directory for feature and/or breaking changes and increase minor or major version number if needed (and not already done) in ``setup.cfg``.
    - keep the ``.dev0`` postfix, the release process will take care of it.
- ``git tag trigger-x.y.z`` the release (with ``x.y.z`` the release number).
    - technical the tag name is irrelevant for the release, but we agree to mirror the version number and prefix with ``trigger-``.
    - Push to master branch; other branches will do the pre/post-release but not actually upload anything to PyPI.
    - Make sure to do ``git push --tags``
- Travis will then release to `PyPI <https://pypi.org/project/Authomatic/#history>`_ as ``bdist_wheel`` and ``sdist`` (egg).
- After deployment the `Authomatic documentation <https://authomatic.github.io/authomatic/>`_ will get build and updated on GitHub Pages
  (only tags on master branch).
{'fraction_non_alphanumeric': 0.11392801251956182, 'fraction_numerical': 0.006259780907668232, 'mean_word_length': 3.879389312977099, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5721900', 'n_tokens_mistral': 916, 'n_tokens_neox': 866, 'n_words': 422}