Building changelogs from fragments.
Project description
changelogging
Building changelogs from fragments.
Installing
Installing the crate with cargo
is quite simple:
$ 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 .
The binaries can be downloaded from releases.
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.2.2"
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
And finally, preview the changelog entry!
$ changelogging preview
## 0.2.2 (YYYY-MM-DD)
### 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.2.2 (YYYY-MM-DD)
### 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for changelogging-2.2.2-py3-none-win_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e80c80217b9e959939d73a381509fb9798e45cdf3c97c4b951bfbf58135bb79 |
|
MD5 | 4dc05f709667565139614cd8ff9c1c30 |
|
BLAKE2b-256 | 73d7cf67abfec97110c51494fabd5f895da826fbd0011afdbdf44b1ba1f52083 |
Hashes for changelogging-2.2.2-py3-none-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf6fa443fd11488bd8e5da1093f1f4ed3a713658ad2098d49f52aea08833148d |
|
MD5 | 41f53f94bc01bad608b2edea7c833854 |
|
BLAKE2b-256 | 1e64ba08f676dbd1ed249aefacd13c95f5bf824be3dd119e4cf7d5aadf7691e1 |
Hashes for changelogging-2.2.2-py3-none-win32.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a58f7ac195e70b92a3e81a20cc2513289fb90cd60749f2f39e9b3a7f871bf462 |
|
MD5 | 164787cf3bd3fd658fc0677835f291a1 |
|
BLAKE2b-256 | 171179aa30e8e3d857786041d827eae008ccb4af509787bb94edf3727e499f4d |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 797a73c16d83073a0149e4f7c8b4bbf557c3701663665ab6c272ce1cfb047861 |
|
MD5 | c521ca91665cc34db9cfa02a90e4f84f |
|
BLAKE2b-256 | ce2c0b387a0ef9c6ca8fd3ef0232fb036af1455041fe9b7c982468cfe7457394 |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d37477fc8c5a7ddf9d8431957804838e78d626b8cb862da46eb7cc56eb979ad |
|
MD5 | 7923368e31d2c6b78101924fdba53203 |
|
BLAKE2b-256 | 1ea280c4f8419f99b9d6d4c0073e17d0ddae3438111fd2a87510186d816ecbca |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5370019e95babddf9cfbf9a27a9c7a790be38bff7bceee9a3ef0689534153dbc |
|
MD5 | 7234b70be9c15be50069eb8e38a2af04 |
|
BLAKE2b-256 | 70e6de727f84fde35de615b0d8061cca448669ef11315d637ab891f985caab0e |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1aa1c6e79cbac076c297a7ea817917970ec4e431c6b2b1911e2d8cab1ce07987 |
|
MD5 | 962fb951a25fdcc52689f973da0a755f |
|
BLAKE2b-256 | c28a3947d148eb555a874871db8378ef8cd967d4d15845eb1137ba354e731b86 |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0fc7d8a206671dc00116173a0d1e9134633e662bf0d83826e8e640423880d92f |
|
MD5 | 68fb8d42606393294eff27c2705411eb |
|
BLAKE2b-256 | 01dcf3331a66571fb006332b36e9a3b0433e3527f8d63013d450f34dc0ef59e4 |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9078a8bc05ff50308ef42dea5f701ad790481086b68d49e41579714fc2bab9ca |
|
MD5 | 232bd051f46ebdbdaa64f530a21fbb18 |
|
BLAKE2b-256 | f104cf0066007d5358a2e77928f5c320a728a3975aa2c7aba5a21f7c54b1ef36 |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25036c2a33f7bb617cadccb1de29c5e0327aec494fb33221ffc3c6cdd542dc46 |
|
MD5 | 417e9f2fc31f6cc6f74ecc1f79442da7 |
|
BLAKE2b-256 | e9558b567d98b20a75c37c6676fa186fd4f9b06fa6067bff2713528cdb420136 |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_5_x86_64.manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c13d99efc2a1825173442dc28926a9fdbe6f275e5ebd1d89207fe9b1c79d594 |
|
MD5 | 9d8fe6568920a43d21e70cdc0f3826b5 |
|
BLAKE2b-256 | 528bbcbe3ba2de5c8884b99e25ce96aebffd3c74a42b6c8e20ff7f8a7435891c |
Hashes for changelogging-2.2.2-py3-none-manylinux_2_5_i686.manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b799b6538fda2e91283aa6610a7326ca42e7d42aaf8839ce760ab8bce5e4c7d |
|
MD5 | b031ab00cfa84dd1f43fed054ab831aa |
|
BLAKE2b-256 | 7bb67c61555b0c2e1d59c87617d846ae388081df2c757321c6519830c516602b |
Hashes for changelogging-2.2.2-py3-none-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7abaee42119bcf50ea9acbe7f59fdf0084da9a7ef4918c1742e6d6546aadc5d |
|
MD5 | 9ebaeb16b551d0973996b00901148fc1 |
|
BLAKE2b-256 | 9d9fc71ac5fe123a34d3bc903439838788657d31836dd795698ebd115fe49e22 |
Hashes for changelogging-2.2.2-py3-none-macosx_10_12_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bf83a02778c2d21abe1895c706d8f6cd914eed8ae998bf3510fed7d7c6cc840 |
|
MD5 | 31c1f8ddb6a64116a1f50c77f18c0f6f |
|
BLAKE2b-256 | 7b52b173e3c96d700664fc5ec59c0498ac8e35119b8137fe7fbaac031e9b8220 |