changelogging
Building changelogs from fragments.
Installation
The binaries can be downloaded from releases.
pipx
Note: because changelogging was originally written in python, releases on PyPI have
different versions: for instance, the 0.7.0 release is on PyPI with version 2.7.0,
meaning the major part of the version is always incremented twice to get the PyPI one.
Installing changelogging with pipx is quite simple:
$ pipx install changelogging
Alternatively, the package can be installed from source:
$ pipx install git+https://github.com/nekitdev/changelogging.git
Or via cloning the repository:
$ git clone https://github.com/nekitdev/changelogging.git
$ cd changelogging
$ pipx install .
cargo
Installing the crate with cargo is as simple as with pipx:
$ cargo install changelogging
Alternatively, the crate can be installed from source:
$ cargo install --git https://github.com/nekitdev/changelogging.git
Or via cloning the repository:
$ git clone https://github.com/nekitdev/changelogging.git
$ cd changelogging
$ cargo install --path .
Example
Once changelogging is installed, we can start building changelogs!
First things first, we need to configure the context of the project.
Create changelogging.toml and add the name, version and URL of the project:
[context]
name = "changelogging"
version = "0.7.0"
url = "https://github.com/nekitdev/changelogging"
Then we need to create the changes directory.
$ mkdir changes
Now we can add fragments:
$ changelogging create --content "Added cool features!" 13.feature.md
$ changelogging create --content "Fixed annoying bugs!" 64.fix.md
There are also unlinked fragments, which have non-integer IDs:
$ changelogging create --content "Fixed security issues!" ~issue.security.md
And finally, preview the changelog entry!
$ changelogging preview
## 0.7.0 (YYYY-MM-DD)
### Security
- Fixed security issues!
### Features
- Added cool features! (#13)
### Fixes
- Fixed annoying bugs! (#64)
Then let us add our CHANGELOG.md file with the following content:
# Changelog
<!-- changelogging: start -->
Note that the start is essential if we want to add some content before the changelog entries.
Assuming the preview is what we expected it to be, writing it to the changelog is as simple as:
$ changelogging build
Finally, let's see the changelog:
$ cat CHANGELOG.md
# Changelog
<!-- changelogging: start -->
## 0.7.0 (YYYY-MM-DD)
### Security
- Fixed security issues!
### Features
- Added cool features! (#13)
### Fixes
- Fixed annoying bugs! (#64)
Documentation
You can find the documentation here.
Support
If you need support with the library, you can send an email or refer to the official Discord server.
Changelog
You can find the changelog here.
Security Policy
You can find the Security Policy of changelogging here.
Contributing
If you are interested in contributing to changelogging, make sure to take a look at the
Contributing Guide, as well as the Code of Conduct.
License
changelogging is licensed under the MIT License terms. See License for details.
1 maintainer
Metadata
1 maintainer
Release files for changelogging 2.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| changelogging-2.7.0.tar.gz | 40.7 kB | Details |
Built distributions (wheels)
Total release size: 18.5 MB
Release files / changelogging-2.7.0.tar.gz
| Download URL | changelogging-2.7.0.tar.gz |
|---|---|
| Size | 40.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
89246e96d1702e48f50d13152ba88d8249dfdc43caff483c4edc99a1b53bc457
|
|
BLAKE2b-256 checksum How to use checksums |
226abf1697336d4221e9c86feac056a9bdc40bcb158cdfc31152d8576be583a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-win_arm64.whl
| Download URL | changelogging-2.7.0-py3-none-win_arm64.whl |
|---|---|
| Size | 919.1 kB |
| Tags | Python 3 Windows ARM64 |
|
SHA-256 checksum How to use checksums |
490f31f98d34da7ebf8bdf786841fdf1bab4728abe21cdf6a925a895891a8eae
|
|
BLAKE2b-256 checksum How to use checksums |
968f073718bed528e21ad24b6cd4f87f01b7b10c6dba945b993ec8de00985439
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-win_amd64.whl
| Download URL | changelogging-2.7.0-py3-none-win_amd64.whl |
|---|---|
| Size | 979.2 kB |
| Tags | Python 3 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
e0ccad349cc386ef69977e11e1d538bda148c8fb9a7e53b799dd5f39d7267f95
|
|
BLAKE2b-256 checksum How to use checksums |
ad790aa601b2af111fe83202cc90b84471c34d9d1028574b37431d5494bccc21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-win32.whl
| Download URL | changelogging-2.7.0-py3-none-win32.whl |
|---|---|
| Size | 897.2 kB |
| Tags | Python 3 Windows x86-32 |
|
SHA-256 checksum How to use checksums |
4ef38f1af4f907d644f4db44401d61574a6c2943510ff7cee9e156fcea835318
|
|
BLAKE2b-256 checksum How to use checksums |
5916b7da85bbf20ee32529a50e8bc80a1cbd3660c18d7623876bcee06271225b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-musllinux_1_2_x86_64.whl
| Download URL | changelogging-2.7.0-py3-none-musllinux_1_2_x86_64.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Linux musl 1.2+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
e6712bd9dd1d59d2a870a5fb929d1fe9e02cbdd4bc16eee67bff71072e7979cb
|
|
BLAKE2b-256 checksum How to use checksums |
943e371a91d949695b6ce3e9d13d817b33aa1d56209c5da7bd66f848a38556ac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-musllinux_1_2_i686.whl
| Download URL | changelogging-2.7.0-py3-none-musllinux_1_2_i686.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Linux musl 1.2+ x86-32 Python 3 |
|
SHA-256 checksum How to use checksums |
9ab8e9c2b75700258e3eb60df71bc21140d4e3937c311225aeb53f315bd342d4
|
|
BLAKE2b-256 checksum How to use checksums |
32e0e4dd4acb684e22ead78c3db0c673a48c0adc9818e751472def1e63b5245d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-musllinux_1_2_armv7l.whl
| Download URL | changelogging-2.7.0-py3-none-musllinux_1_2_armv7l.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Linux musl 1.2+ ARMv7l Python 3 |
|
SHA-256 checksum How to use checksums |
0bfd39a433196a53978319628bf8c599fcab1dc995bcb87e2722404bff2ff47d
|
|
BLAKE2b-256 checksum How to use checksums |
149f06c2380815c6945e66c28f8e1fadc78f46a6aba5041482e4b58ea9a4c277
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-musllinux_1_2_aarch64.whl
| Download URL | changelogging-2.7.0-py3-none-musllinux_1_2_aarch64.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Linux musl 1.2+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
462aaf77ae722650311b622645cbbe7531e63b222dd11df4561fa175150ed6b4
|
|
BLAKE2b-256 checksum How to use checksums |
bcdbbc6bfd7c960562c2498b262008c9c16189fa66c4c163fb17a3d157577e42
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | changelogging-2.7.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 1.2 MB |
| Tags | Linux glibc 2.17+ x86-64 Python 3 |
|
SHA-256 checksum How to use checksums |
379fd41a5f104bfe26754512c664d0efb74d6e41f20389a3d8a41fdb9036b908
|
|
BLAKE2b-256 checksum How to use checksums |
844abd2c0c9eb19b397bae2984e036e11f8668a7c83175a3faaafa1b189f9e3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
| Download URL | changelogging-2.7.0-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl |
|---|---|
| Size | 1.4 MB |
| Tags | Linux glibc 2.17+ IBM System/390x Python 3 |
|
SHA-256 checksum How to use checksums |
f49cb820f97092b83159b9f25247c4244b0576da5016f5211e2d2277b845c840
|
|
BLAKE2b-256 checksum How to use checksums |
aa40ebf185d62d0d0d38b2d0f8eb8f658cbb7cbca514922a5ed055e8de8d0c8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
| Download URL | changelogging-2.7.0-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Linux glibc 2.17+ PowerPC 64-le Python 3 |
|
SHA-256 checksum How to use checksums |
359180e22d40de39a15d86654eb2359d3eb25b603be16537054a6856b0753807
|
|
BLAKE2b-256 checksum How to use checksums |
0f0d20539f770b8ebdd832ec8a0b2df980c133f718cdae529d0a5782c64283d1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl
| Download URL | changelogging-2.7.0-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Linux glibc 2.17+ PowerPC 64-be Python 3 |
|
SHA-256 checksum How to use checksums |
921928d53334aef69203a13047af58e30e7b387e8818599535aaa9cfa9014e44
|
|
BLAKE2b-256 checksum How to use checksums |
f2a0f1addfffe1b3c573fe9078782368e742c0f033bb2909c1ddef58713949f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
| Download URL | changelogging-2.7.0-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl |
|---|---|
| Size | 1.3 MB |
| Tags | Linux glibc 2.17+ x86-32 Python 3 |
|
SHA-256 checksum How to use checksums |
4e4804919bef40da7ac8dfa67df171a1a8b14daad1f419f7a775744d7c505659
|
|
BLAKE2b-256 checksum How to use checksums |
6edb754d8240507e6bc572a669ff7d1034d1db117242c60073fbad791fb11f25
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
| Download URL | changelogging-2.7.0-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Linux glibc 2.17+ ARMv7l Python 3 |
|
SHA-256 checksum How to use checksums |
28abb1f2a96ba9304134538bbd4920557182f5d187fd83160551625c05254a02
|
|
BLAKE2b-256 checksum How to use checksums |
2cf0490fc9ba54abb36128d223c6dd18c43935d35ded3c08355e7ac810cb2573
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | changelogging-2.7.0-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Linux glibc 2.17+ ARM64 Python 3 |
|
SHA-256 checksum How to use checksums |
1f89c34cd56627ff23aa31a51e1bc7693bc004296f40cb29fecf67a2ac763f2f
|
|
BLAKE2b-256 checksum How to use checksums |
bcf72277b0c19596141e1d08d8210224a894cc16aaa3f3d3fe3afbb904719fb0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-macosx_11_0_arm64.whl
| Download URL | changelogging-2.7.0-py3-none-macosx_11_0_arm64.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
f548df1d9b9fc6d0fffdf0465249719727f79f74a97bb725b2f210c579acab30
|
|
BLAKE2b-256 checksum How to use checksums |
e97cf5957be5c99916af40b78dbda182fdc929418d181ce98bad634e6cab7418
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency logRelease files / changelogging-2.7.0-py3-none-macosx_10_12_x86_64.whl
| Download URL | changelogging-2.7.0-py3-none-macosx_10_12_x86_64.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
7663d312b5bd6a2f03c5e48c7eef66d07ef5f28c35e62490d40c9799375ea3e1
|
|
BLAKE2b-256 checksum How to use checksums |
4b3948e6dc83f571b5dc2d8b8234071feddea063eead73e97a6a9d982a416d55
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 5, 2024.
Transparency log
