changelog_gen


Namechangelog_gen JSON
Version 0.12.1 PyPI version JSON
download
home_pagehttps://github.com/NRWLDev/changelog-gen/
SummaryChangelog generation tool
upload_time2024-09-06 09:08:40
maintainerDaniel Edgecombe
docs_urlNone
authorDaniel Edgecombe
requires_python<4.0,>=3.8
licenseApache-2.0
keywords changelog version release bumpversion
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Changelog Generator - v0.12.1
[![image](https://img.shields.io/pypi/v/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)
[![image](https://img.shields.io/pypi/l/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)
[![image](https://img.shields.io/pypi/pyversions/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)
![style](https://github.com/NRWLDev/changelog-gen/actions/workflows/style.yml/badge.svg)
![tests](https://github.com/NRWLDev/changelog-gen/actions/workflows/tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/NRWLDev/changelog-gen/branch/main/graph/badge.svg)](https://codecov.io/gh/NRWLDev/changelog-gen)

# Details

`changelog-gen` is a CHANGELOG generator, to detect semantic versioning changes
from conventional commits, and generate release tags.

See the [docs](https://nrwldev.github.io/changelog-gen) for more details.

## Usage

`changelog init` will generate an empty changelog file if you have not been
maintaining changelogs previously. If you already have a changelog file, it
will be detected.

`changelog generate` will extract all commits matching the conventional format
since the last release, detect the correct semantic version component to
increment, and generate the correct changelog entry. Depending on
configuration, it will also update release tags in files as well as tagging the
release.

```bash
$ git log --oneline
a4e1449 feat: Open changes in editor before confirmation, to allow modification.
c314b6b feat: Block generation if local/remote are out of sync.
2e25deb chore: Relax typer version to 0.X
a95fd80 fix: Handle warning message from bump-my-version if setup.cfg exists
b46d2fe fix: Clean up link generation format in MDWriter
```

Using the above commits, can generate the following example changelog entry.

```md
# Changelog

## v0.9.2 - 2024-03-08

### Features and Improvements
- Open changes in editor before confirmation, to allow modification. [[#1](https://github.com/NRWLDev/changelog-gen/issues/1)] [[a4e1449](https://github.com/NRWLDev/changelog-gen/commit/a4e1449bf44f370c671cc679d4bf9cfd75e68cbf)]
- Block generation if local/remote are out of sync. [[#2](https://github.com/NRWLDev/changelog-gen/issues/2)] [[c314b6b](https://github.com/NRWLDev/changelog-gen/commit/c314b6b8a32f4ce5c05869f0accd24bb4e6097f2)]

### Bug fixes
- Handle warning message from bump-my-version if setup.cfg exists [[a95fd80](https://github.com/NRWLDev/changelog-gen/commit/a95fd80d939985ab4b51a864676dda234e345d47)]
- Clean up link generation format in MDWriter [[b46d2fe](https://github.com/NRWLDev/changelog-gen/commit/b46d2fe6fba5a170f25dffbf8697868d14a4e73e)]

### Miscellaneous
- Relax typer version to 0.X [[2e25deb](https://github.com/NRWLDev/changelog-gen/commit/2e25deb902710343a0f85f40323762752eef4a45)]
```

## Migrating from 0.8 to 0.9 (Conventional Commit support)
Check the discussion
[here](https://github.com/EdgyEdgemond/changelog-gen/discussions/98) for
details on how to update usage to maintain legacy functionality or move over to
new features.

## Installation

```bash
pip install changelog-gen
```

or clone this repo and install with invoke/poetry.

```bash
invoke install-dev
```

## Contributing

This project uses pre-commit hooks, please run `invoke install-dev` after
cloning to install dev dependencies and commit hooks.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/NRWLDev/changelog-gen/",
    "name": "changelog_gen",
    "maintainer": "Daniel Edgecombe",
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": "daniel@nrwl.co",
    "keywords": "changelog, version, release, bumpversion",
    "author": "Daniel Edgecombe",
    "author_email": "daniel@nrwl.co",
    "download_url": "https://files.pythonhosted.org/packages/b8/c8/3ef3441bf1a697a1fd8f32df863d27e10c063350a9063f40bd70a85ed04f/changelog_gen-0.12.1.tar.gz",
    "platform": null,
    "description": "# Changelog Generator - v0.12.1\n[![image](https://img.shields.io/pypi/v/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)\n[![image](https://img.shields.io/pypi/l/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)\n[![image](https://img.shields.io/pypi/pyversions/changelog_gen.svg)](https://pypi.org/project/changelog_gen/)\n![style](https://github.com/NRWLDev/changelog-gen/actions/workflows/style.yml/badge.svg)\n![tests](https://github.com/NRWLDev/changelog-gen/actions/workflows/tests.yml/badge.svg)\n[![codecov](https://codecov.io/gh/NRWLDev/changelog-gen/branch/main/graph/badge.svg)](https://codecov.io/gh/NRWLDev/changelog-gen)\n\n# Details\n\n`changelog-gen` is a CHANGELOG generator, to detect semantic versioning changes\nfrom conventional commits, and generate release tags.\n\nSee the [docs](https://nrwldev.github.io/changelog-gen) for more details.\n\n## Usage\n\n`changelog init` will generate an empty changelog file if you have not been\nmaintaining changelogs previously. If you already have a changelog file, it\nwill be detected.\n\n`changelog generate` will extract all commits matching the conventional format\nsince the last release, detect the correct semantic version component to\nincrement, and generate the correct changelog entry. Depending on\nconfiguration, it will also update release tags in files as well as tagging the\nrelease.\n\n```bash\n$ git log --oneline\na4e1449 feat: Open changes in editor before confirmation, to allow modification.\nc314b6b feat: Block generation if local/remote are out of sync.\n2e25deb chore: Relax typer version to 0.X\na95fd80 fix: Handle warning message from bump-my-version if setup.cfg exists\nb46d2fe fix: Clean up link generation format in MDWriter\n```\n\nUsing the above commits, can generate the following example changelog entry.\n\n```md\n# Changelog\n\n## v0.9.2 - 2024-03-08\n\n### Features and Improvements\n- Open changes in editor before confirmation, to allow modification. [[#1](https://github.com/NRWLDev/changelog-gen/issues/1)] [[a4e1449](https://github.com/NRWLDev/changelog-gen/commit/a4e1449bf44f370c671cc679d4bf9cfd75e68cbf)]\n- Block generation if local/remote are out of sync. [[#2](https://github.com/NRWLDev/changelog-gen/issues/2)] [[c314b6b](https://github.com/NRWLDev/changelog-gen/commit/c314b6b8a32f4ce5c05869f0accd24bb4e6097f2)]\n\n### Bug fixes\n- Handle warning message from bump-my-version if setup.cfg exists [[a95fd80](https://github.com/NRWLDev/changelog-gen/commit/a95fd80d939985ab4b51a864676dda234e345d47)]\n- Clean up link generation format in MDWriter [[b46d2fe](https://github.com/NRWLDev/changelog-gen/commit/b46d2fe6fba5a170f25dffbf8697868d14a4e73e)]\n\n### Miscellaneous\n- Relax typer version to 0.X [[2e25deb](https://github.com/NRWLDev/changelog-gen/commit/2e25deb902710343a0f85f40323762752eef4a45)]\n```\n\n## Migrating from 0.8 to 0.9 (Conventional Commit support)\nCheck the discussion\n[here](https://github.com/EdgyEdgemond/changelog-gen/discussions/98) for\ndetails on how to update usage to maintain legacy functionality or move over to\nnew features.\n\n## Installation\n\n```bash\npip install changelog-gen\n```\n\nor clone this repo and install with invoke/poetry.\n\n```bash\ninvoke install-dev\n```\n\n## Contributing\n\nThis project uses pre-commit hooks, please run `invoke install-dev` after\ncloning to install dev dependencies and commit hooks.\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Changelog generation tool",
    "version": "0.12.1",
    "project_urls": {
        "Homepage": "https://github.com/NRWLDev/changelog-gen/",
        "Repository": "https://github.com/NRWLDev/changelog-gen/"
    },
    "split_keywords": [
        "changelog",
        " version",
        " release",
        " bumpversion"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "87131f7f94f03ffd168a63205eccf30e67a71b2c3736bddfee27ff60615243ed",
                "md5": "d4422897cafa1bd00a89d9a11e94e8af",
                "sha256": "6b726456883108230d570901824e132c7ff6a5713478a0f36edf37d7e5990ec2"
            },
            "downloads": -1,
            "filename": "changelog_gen-0.12.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d4422897cafa1bd00a89d9a11e94e8af",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 26798,
            "upload_time": "2024-09-06T09:08:38",
            "upload_time_iso_8601": "2024-09-06T09:08:38.744358Z",
            "url": "https://files.pythonhosted.org/packages/87/13/1f7f94f03ffd168a63205eccf30e67a71b2c3736bddfee27ff60615243ed/changelog_gen-0.12.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b8c83ef3441bf1a697a1fd8f32df863d27e10c063350a9063f40bd70a85ed04f",
                "md5": "157ef1dbfb844591960a8c47d1076683",
                "sha256": "bfd2cdf83f826b706aa5cfc5d117c3e30c217c1af2b5838c5f70fd2bdb96f577"
            },
            "downloads": -1,
            "filename": "changelog_gen-0.12.1.tar.gz",
            "has_sig": false,
            "md5_digest": "157ef1dbfb844591960a8c47d1076683",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 23448,
            "upload_time": "2024-09-06T09:08:40",
            "upload_time_iso_8601": "2024-09-06T09:08:40.419040Z",
            "url": "https://files.pythonhosted.org/packages/b8/c8/3ef3441bf1a697a1fd8f32df863d27e10c063350a9063f40bd70a85ed04f/changelog_gen-0.12.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-06 09:08:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "NRWLDev",
    "github_project": "changelog-gen",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "changelog_gen"
}
Daniel Edgecombe
Elapsed time: 0.38133s