@ -6,11 +6,13 @@ All notable changes to this project will be documented in this file
### Changed
### Changed
- API changes:
- `header` attribute renamed to `preamble` to avoid confusion.
- improved version header parsing to be more robust and handle multi-word version names.
- improved version header parsing to be more robust and handle multi-word version names.
- improved version number incrementing in `release`.
- improved version number incrementing in `release`.
- can now handle other text surrounding a pep440-compliant version number, which will not be modified
- can now handle other text surrounding a pep440-compliant version number, which will not be modified
- can now handle pre-releases correctly. The version to increment is the most recent version in the log with a valid pep440 version number in it. Release increment and prerelease increments can be mixed, allowing e.g: `yaclog release -mr` to create a release candidate with in incremented minor version number.
- can now handle pre-releases correctly. The version to increment is the most recent version in the log with a valid pep440 version number in it.
- `header` attribute on the changelog class has been split into `title` and `preamble`
- Release increment and prerelease increments can be mixed, allowing e.g: `yaclog release -mr` to create a release candidate with in incremented minor version number.
### Removed
### Removed
@ -20,6 +22,7 @@ All notable changes to this project will be documented in this file
- Terminal output has color to distinguish version names/headers, sections, and git information
- Terminal output has color to distinguish version names/headers, sections, and git information
## 0.3.3 - 2021-04-27
## 0.3.3 - 2021-04-27
### Added
### Added
@ -34,6 +37,7 @@ All notable changes to this project will be documented in this file
- `release` now resets lesser version values when incrementing
- `release` now resets lesser version values when incrementing
- `release` now works with logs that have only unreleased changes
- `release` now works with logs that have only unreleased changes
## 0.3.2 - 2021-04-24
## 0.3.2 - 2021-04-24
### Added
### Added
@ -49,6 +53,7 @@ All notable changes to this project will be documented in this file
- `release` and `entry` commands now work using empty changelogs.
- `release` and `entry` commands now work using empty changelogs.
## 0.3.1 - 2021-04-24
## 0.3.1 - 2021-04-24
### Added
### Added
@ -61,6 +66,7 @@ All notable changes to this project will be documented in this file
- `tag` command for manipulating tags in the changelog
- `tag` command for manipulating tags in the changelog
- `release` command for creating releases
- `release` command for creating releases
## 0.2.0 - 2021-04-19
## 0.2.0 - 2021-04-19
### Added
### Added
@ -74,6 +80,7 @@ All notable changes to this project will be documented in this file
- Parser can now handle code blocks.
- Parser can now handle code blocks.
- Parser can now handle setext-style headers and H2s not conforming to the schema.
- Parser can now handle setext-style headers and H2s not conforming to the schema.
Yaclog works on markdown changelog files, using a machine-readable format based on what is proposed by [Keep a Changelog](https://keepachangelog.com). Changelog files can be created using the {command}`yaclog init` command.
Yaclog works on markdown changelog files, using a machine-readable format based on what is proposed by [Keep a Changelog](https://keepachangelog.com). Changelog files can be created using the {command}`yaclog init` command.
## Title
The title is the first H1 in the file giving its title, usually `# Changlog`.
## Preamble
## Preamble
The preamble is the text at the top of the file before any version information. It can contain an explanation of the file's purpose, as well as any general machine-readable information you may want to include for use with other tools. Yaclog does not provide any ways to manipulate the front matter from the command line due to its open-ended nature.
The preamble is the text at the top of the file before any version information. It can contain the title, an explanation of the file's purpose, as well as any general machine-readable information you may want to include for use with other tools. Yaclog does not provide any ways to manipulate the front matter from the command line due to its open-ended nature.
## Versions
## Versions
@ -17,9 +13,11 @@ Version information begins with a header, which is an H2 containing the version'
```markdown
```markdown
## 1.0.0
## 1.0.0
```
```
```markdown
```markdown
## 3.2.0 "Columbia" - 1981-07-20
## 3.2.0 "Columbia" - 1981-07-20
```
```
```markdown
```markdown
## Version 8.0.0rc1 1988-11-15 [PRERELEASE]
## Version 8.0.0rc1 1988-11-15 [PRERELEASE]
```
```
@ -54,7 +52,6 @@ Yanked due to issues with oxygen tanks, currently investigating
- Replaced Ken Mattingly
- Replaced Ken Mattingly
- Stirred oxygen tanks
- Stirred oxygen tanks
## 0.12.0 "Intrepid" - 1969-11-14
## 0.12.0 "Intrepid" - 1969-11-14
### Added
### Added
@ -71,7 +68,6 @@ Yanked due to issues with oxygen tanks, currently investigating
- Lightning strike during launch: No effect on performance
- Lightning strike during launch: No effect on performance