Skip to main content

Changelogs without conflicts.

Project description

changelogd

https://img.shields.io/pypi/v/changelogd.svg https://dev.azure.com/aklajnert/changelogd/_apis/build/status/aklajnert.changelogd?branchName=master

Changelogs without conflicts.

Overview

Changelogd allows teams to avoid merge conflicts for the changelog files. The changelogd content is stored within multiple YAML files - one per each changelog entry. Then, during application release, all input files are combined into one release file. The script uses Jinja2 templates to generate one consistent text file out of all input YAML files. The default output format is Markdown, but by modifying the templates it can be changed into any text format you like.

Installation

You can install changelogd via pip from PyPI:

$ pip install changelogd

Quickstart

First, initialize changelogd configuration.

$ changelogd init
Created main configuration file: changelog.d\config.yaml
Copied templates to changelog.d\templates

Then, create changelog entries:

$ changelogd entry
        [1]: feature
        [2]: bug
        [3]: doc
        [4]: deprecation
        [5]: other
> Select message type [1]: 2
> Issue ID: 100
> Changelog message: Changelog message
Created changelog entry at changelog.d\bug.a3f13823.entry.yaml

Finally, generate changelog file.

$ changelogd release version-number
> Release description (hit ENTER to omit): This is the initial release.
Saved new release data into changelog.d\releases\0.release-name.yaml
Generated changelog file to changelog.md

Output file:

# Changelog


## version-number (2020-01-11)

This is the initial release.

### Bug fixes
* [#100](http://repo/issues/100): Changelog message ([@user](user@example.com))

Documentation

For full documentation, please see https://changelogd.readthedocs.io/en/latest/.

License

Distributed under the terms of the MIT license, “pytest-subprocess” is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

History

0.1.2 (2020-01-17)

Bug fixes

  • Fixed missing templates from the MANIFEST.in

0.1.1 (2020-01-16)

Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

changelogd-0.1.2.tar.gz (26.0 kB view details)

Uploaded Source

Built Distribution

changelogd-0.1.2-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file changelogd-0.1.2.tar.gz.

File metadata

  • Download URL: changelogd-0.1.2.tar.gz
  • Upload date:
  • Size: 26.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0

File hashes

Hashes for changelogd-0.1.2.tar.gz
Algorithm Hash digest
SHA256 bf76c93041f7e086022251ef5a4b47008f9b77f64c38531120d315de3da7d166
MD5 90681f1553aa51b5900391f2d7ee04d1
BLAKE2b-256 a2e61b28f2fa5527e05f71a8b566c2dac8c9638a82bf0e8794abca3c6ab58d19

See more details on using hashes here.

File details

Details for the file changelogd-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: changelogd-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/3.8.0

File hashes

Hashes for changelogd-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b1c0dda8104f3de503438fa4309ca1cdbcb5333e99cc4d43ddb55f36fa7071cb
MD5 0d54d43304e12bd8b7d307a36213a2de
BLAKE2b-256 fd2a8146d8b23497b06e62a1397c9b7b34f042c9f7385fe69f57424cda84a29a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page