Auto Changelog
==============
|actions| |ci| |pypi| |version| |licence| |black|
.. |ci| image:: https://gitlab.com/KeNaCo/auto-changelog/badges/master/pipeline.svg
:target: https://gitlab.com/KeNaCo/auto-changelog/-/commits/master
:alt: Gitlab CI
.. |actions| image:: https://github.com/KeNaCo/auto-changelog/actions/workflows/ci.yml/badge.svg?branch=master
:target: https://github.com/KeNaCo/auto-changelog/actions/workflows/ci.yml
:alt: Github Actions
.. |pypi| image:: https://img.shields.io/pypi/v/auto-changelog
:target: https://pypi.org/project/auto-changelog/
:alt: PyPI
.. |version| image:: https://img.shields.io/pypi/pyversions/auto-changelog
:alt: PyPI - Python Version
.. |licence| image:: https://img.shields.io/pypi/l/auto-changelog
:alt: PyPI - License
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:alt: Code style - Black
A quick script that will generate a changelog for any git repository using `conventional style`_ commit messages.
Installation
------------
Install and update using `pip`_:
.. code-block:: text
pip install auto-changelog
or directly from source(via `Poetry`_):
.. code-block:: text
poetry install
poetry build
pip install dist/*.whl
Usage
-----
You can list the command line options by running `auto-changelog --help`:
.. code-block:: text
Usage: auto-changelog [OPTIONS]
Options:
-p, --path-repo PATH Path to the repository's root directory
[Default: .]
-t, --title TEXT The changelog's title [Default: Changelog]
-d, --description TEXT Your project's description
-o, --output FILENAME The place to save the generated changelog
[Default: CHANGELOG.md]
-r, --remote TEXT Specify git remote to use for links
-v, --latest-version TEXT use specified version as latest release
-u, --unreleased Include section for unreleased changes
--template TEXT specify template to use [compact] or a path to a
custom template, default: compact
--diff-url TEXT override url for compares, use {current} and
{previous} for tags
--issue-url TEXT Override url for issues, use {id} for issue id
--issue-pattern TEXT Override regex pattern for issues in commit
messages. Should contain two groups, original
match and ID used by issue-url.
--tag-pattern TEXT override regex pattern for release tags. By
default use semver tag names semantic. tag should
be contain in one group named 'version'.
--tag-prefix TEXT prefix used in version tags, default: ""
--stdout
--tag-pattern TEXT Override regex pattern for release tags
--starting-commit TEXT Starting commit to use for changelog generation
--stopping-commit TEXT Stopping commit to use for changelog generation
--debug set logging level to DEBUG
--help Show this message and exit.
A simple example
----------------
.. image:: example-usage.gif
:alt: Example usage of auto-changelog
Contributing
------------
To setup development environment, you may use `Poetry`_.
These instructions will assume that you have already `Poetry`_ as well as GNU make locally installed
on your development computer.
These instructions will assume that you have already poetry (https://python-poetry.org/) locally installed
on your development computer.
1. Fork the `auto-changelog` repo on GitHub.
2. Clone your fork locally::
$ git clone git@github.com:your_name_here/auto-changelog.git
3. Initialize your local development environment of auto-changelog.
This will include creating a virtualenv using poetry, installing dependencies and registering git hooks
using pre-commit::
$ cd auto-changelog/
$ make init-dev
4. Create a branch for local development::
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
5. When you're done making changes, check that your changes pass linting, formating, and the
tests, including testing other Python versions with tox::
$ make lint # check style with flake8
$ make format # run autoformat with isort and black
$ make test # run tests quickly with the default Python
$ make test-all # run tests on every Python version with tox
6. Commit your changes and push your branch to GitHub. Upon commit pre-commit will automatically run
flake8 and black and report if changes have been made or need to be fixed by you::
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
7. Submit a pull request through the GitHub website.
.. _Black: https://black.readthedocs.io/en/stable/
.. _conventional style: https://www.conventionalcommits.org/en
.. _pip: https://pip.pypa.io/en/stable/quickstart/
.. _Poetry: https://poetry.eustace.io/
.. _Pre-commit: https://pre-commit.com/
Raw data
{
"_id": null,
"home_page": "https://github.com/Michael-F-Bryan/auto-changelog",
"name": "auto-changelog",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.2",
"maintainer_email": "",
"keywords": "git,changelog",
"author": "Michael F Bryan",
"author_email": "michaelfbryan@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/46/55/4879daf7317e566b73fd79320bbeb01b74c42d7e54f137eec2ac1b73b7a1/auto_changelog-0.6.0.tar.gz",
"platform": null,
"description": "Auto Changelog\n==============\n\n|actions| |ci| |pypi| |version| |licence| |black|\n\n.. |ci| image:: https://gitlab.com/KeNaCo/auto-changelog/badges/master/pipeline.svg\n :target: https://gitlab.com/KeNaCo/auto-changelog/-/commits/master\n :alt: Gitlab CI\n.. |actions| image:: https://github.com/KeNaCo/auto-changelog/actions/workflows/ci.yml/badge.svg?branch=master\n :target: https://github.com/KeNaCo/auto-changelog/actions/workflows/ci.yml\n :alt: Github Actions\n.. |pypi| image:: https://img.shields.io/pypi/v/auto-changelog\n :target: https://pypi.org/project/auto-changelog/\n :alt: PyPI\n.. |version| image:: https://img.shields.io/pypi/pyversions/auto-changelog\n :alt: PyPI - Python Version\n.. |licence| image:: https://img.shields.io/pypi/l/auto-changelog\n :alt: PyPI - License\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :alt: Code style - Black\n\nA quick script that will generate a changelog for any git repository using `conventional style`_ commit messages.\n\nInstallation\n------------\n\nInstall and update using `pip`_:\n\n.. code-block:: text\n\n pip install auto-changelog\n\nor directly from source(via `Poetry`_):\n\n.. code-block:: text\n\n poetry install\n poetry build\n pip install dist/*.whl\n\nUsage\n-----\nYou can list the command line options by running `auto-changelog --help`:\n\n.. code-block:: text\n\n Usage: auto-changelog [OPTIONS]\n\n Options:\n -p, --path-repo PATH Path to the repository's root directory\n [Default: .]\n\n -t, --title TEXT The changelog's title [Default: Changelog]\n -d, --description TEXT Your project's description\n -o, --output FILENAME The place to save the generated changelog\n [Default: CHANGELOG.md]\n\n -r, --remote TEXT Specify git remote to use for links\n -v, --latest-version TEXT use specified version as latest release\n -u, --unreleased Include section for unreleased changes\n --template TEXT specify template to use [compact] or a path to a\n custom template, default: compact\n\n --diff-url TEXT override url for compares, use {current} and\n {previous} for tags\n\n --issue-url TEXT Override url for issues, use {id} for issue id\n --issue-pattern TEXT Override regex pattern for issues in commit\n messages. Should contain two groups, original\n match and ID used by issue-url.\n\n --tag-pattern TEXT override regex pattern for release tags. By\n default use semver tag names semantic. tag should\n be contain in one group named 'version'.\n\n --tag-prefix TEXT prefix used in version tags, default: \"\"\n --stdout\n --tag-pattern TEXT Override regex pattern for release tags\n --starting-commit TEXT Starting commit to use for changelog generation\n --stopping-commit TEXT Stopping commit to use for changelog generation\n --debug set logging level to DEBUG\n --help Show this message and exit.\n\n\nA simple example\n----------------\n\n.. image:: example-usage.gif\n :alt: Example usage of auto-changelog\n\nContributing\n------------\n\nTo setup development environment, you may use `Poetry`_.\nThese instructions will assume that you have already `Poetry`_ as well as GNU make locally installed\non your development computer.\n\nThese instructions will assume that you have already poetry (https://python-poetry.org/) locally installed\non your development computer.\n\n1. Fork the `auto-changelog` repo on GitHub.\n2. Clone your fork locally::\n\n $ git clone git@github.com:your_name_here/auto-changelog.git\n\n3. Initialize your local development environment of auto-changelog.\n This will include creating a virtualenv using poetry, installing dependencies and registering git hooks\n using pre-commit::\n\n $ cd auto-changelog/\n $ make init-dev\n\n4. Create a branch for local development::\n\n $ git checkout -b name-of-your-bugfix-or-feature\n\n Now you can make your changes locally.\n\n5. When you're done making changes, check that your changes pass linting, formating, and the\n tests, including testing other Python versions with tox::\n\n $ make lint # check style with flake8\n $ make format # run autoformat with isort and black\n $ make test # run tests quickly with the default Python\n $ make test-all # run tests on every Python version with tox\n\n\n6. Commit your changes and push your branch to GitHub. Upon commit pre-commit will automatically run\n flake8 and black and report if changes have been made or need to be fixed by you::\n\n $ git add .\n $ git commit -m \"Your detailed description of your changes.\"\n $ git push origin name-of-your-bugfix-or-feature\n\n7. Submit a pull request through the GitHub website.\n\n\n\n.. _Black: https://black.readthedocs.io/en/stable/\n.. _conventional style: https://www.conventionalcommits.org/en\n.. _pip: https://pip.pypa.io/en/stable/quickstart/\n.. _Poetry: https://poetry.eustace.io/\n.. _Pre-commit: https://pre-commit.com/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Simple tool to generate nice, formatted changelogs from vcs",
"version": "0.6.0",
"project_urls": {
"Homepage": "https://github.com/Michael-F-Bryan/auto-changelog",
"Repository": "https://github.com/Michael-F-Bryan/auto-changelog"
},
"split_keywords": [
"git",
"changelog"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c5033229ee43b8c92abeb1cd4bc600104b5cbe8c42a1e9bb2d847abe9c5a8706",
"md5": "79ee27da4e647f1260a7eb7a56cf1bae",
"sha256": "c14e647b767758f483a7567d7be5a0c79b8ecbd52b4bdc6fed2a98aba9ed86d8"
},
"downloads": -1,
"filename": "auto_changelog-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79ee27da4e647f1260a7eb7a56cf1bae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.2",
"size": 13650,
"upload_time": "2022-11-28T17:58:51",
"upload_time_iso_8601": "2022-11-28T17:58:51.007802Z",
"url": "https://files.pythonhosted.org/packages/c5/03/3229ee43b8c92abeb1cd4bc600104b5cbe8c42a1e9bb2d847abe9c5a8706/auto_changelog-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46554879daf7317e566b73fd79320bbeb01b74c42d7e54f137eec2ac1b73b7a1",
"md5": "6b3a1c1d92f711b5cea2e385b9084045",
"sha256": "ae930fd187d32df92a0e63b96a710a954cd387fcb4a592492abfcd0d3cfbd6fa"
},
"downloads": -1,
"filename": "auto_changelog-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "6b3a1c1d92f711b5cea2e385b9084045",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.2",
"size": 13722,
"upload_time": "2022-11-28T17:58:53",
"upload_time_iso_8601": "2022-11-28T17:58:53.356345Z",
"url": "https://files.pythonhosted.org/packages/46/55/4879daf7317e566b73fd79320bbeb01b74c42d7e54f137eec2ac1b73b7a1/auto_changelog-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-28 17:58:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Michael-F-Bryan",
"github_project": "auto-changelog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "auto-changelog"
}
JSON
