2021-04-17 04:47:21 +00:00
|
|
|
# Changelog
|
2021-04-23 05:48:48 +00:00
|
|
|
|
2021-04-17 04:47:21 +00:00
|
|
|
All notable changes to this project will be documented in this file
|
|
|
|
|
2021-04-25 09:16:19 +00:00
|
|
|
## Unreleased
|
|
|
|
|
|
|
|
### Added
|
|
|
|
|
|
|
|
- Unit tests in the `tests` folder
|
|
|
|
|
2021-04-25 09:24:22 +00:00
|
|
|
### Changed
|
|
|
|
|
2021-04-26 02:28:50 +00:00
|
|
|
- Default links and dates in VersionEntry are now consistently `None`
|
2021-04-26 05:47:55 +00:00
|
|
|
- Changelog links dict now contains version links.
|
|
|
|
Modified version links will overwrite those in the table when writing to a file
|
2021-04-26 02:28:50 +00:00
|
|
|
- Changelog object no longer errors when creating without a path.
|
2021-04-26 05:19:14 +00:00
|
|
|
- `release` now resets lesser version values when incrementing
|
2021-04-26 05:20:42 +00:00
|
|
|
- `release` now works with logs that have only unreleased changes
|
2021-04-25 09:24:22 +00:00
|
|
|
|
2021-04-24 21:01:47 +00:00
|
|
|
## 0.3.2 - 2021-04-24
|
2021-04-24 09:23:15 +00:00
|
|
|
|
2021-04-24 09:58:59 +00:00
|
|
|
### Added
|
|
|
|
|
2021-04-24 20:59:56 +00:00
|
|
|
- Readme file now has installation and usage instructions.
|
|
|
|
- yaclog command entry point added to setup.cfg.
|
2021-04-24 09:58:59 +00:00
|
|
|
|
2021-04-24 09:23:15 +00:00
|
|
|
### Changed
|
|
|
|
|
2021-04-24 20:59:56 +00:00
|
|
|
- `release -c` will no longer create empty commits, and will use the current commit instead.
|
2021-04-24 09:23:15 +00:00
|
|
|
|
2021-04-24 09:58:59 +00:00
|
|
|
### Fixed
|
|
|
|
|
2021-04-24 20:59:56 +00:00
|
|
|
- `release` and `entry` commands now work using empty changelogs.
|
2021-04-24 09:58:59 +00:00
|
|
|
|
2021-04-24 07:09:59 +00:00
|
|
|
## 0.3.1 - 2021-04-24
|
2021-04-23 05:48:48 +00:00
|
|
|
|
|
|
|
### Added
|
|
|
|
|
|
|
|
- `yaclog` tool for manipulating changelogs from the command line
|
|
|
|
- `init` command to make a new changelog
|
|
|
|
- `format` command to reformat the changelog
|
|
|
|
- `show` command to show changes from the changelog
|
2021-04-23 18:17:44 +00:00
|
|
|
- `entry` command for manipulating entries in the changelog
|
|
|
|
- `tag` command for manipulating tags in the changelog
|
2021-04-24 06:57:53 +00:00
|
|
|
- `release` command for creating releases
|
2021-04-23 05:48:48 +00:00
|
|
|
|
2021-04-19 05:49:11 +00:00
|
|
|
## 0.2.0 - 2021-04-19
|
2021-04-19 05:04:22 +00:00
|
|
|
|
|
|
|
### Added
|
|
|
|
|
|
|
|
- New yak log logo drawn by my sister
|
|
|
|
|
|
|
|
### Changed
|
|
|
|
|
|
|
|
- Updated package metadata
|
|
|
|
- Rewrote parser to use a 2-step method that is more flexible.
|
|
|
|
- Parser can now handle code blocks.
|
2021-04-23 05:48:48 +00:00
|
|
|
- Parser can now handle setext-style headers and H2s not conforming to the schema.
|
2021-04-19 05:04:22 +00:00
|
|
|
|
2021-04-17 04:47:21 +00:00
|
|
|
## 0.1.0 - 2021-04-16
|
|
|
|
|
|
|
|
First release
|
|
|
|
|
|
|
|
### Added
|
2021-04-19 05:04:22 +00:00
|
|
|
|
2021-04-24 07:02:04 +00:00
|
|
|
- `yaclog.read()` method to parse changelog files
|