Skip to content

Commit dc552f5

Browse files
committed
release: officially adopt Keep a Changelog
We are already using the format so might as well link to where it comes from. Also adjust the release-notes.sh line to account for 5 additional lines at the top. Signed-off-by: Pablo Barbáchano <[email protected]>
1 parent 3fb0368 commit dc552f5

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Changelog
22

3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
38
## [Unreleased]
49

510
### Added

tools/release-notes.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ changelog="$FC_ROOT_DIR/CHANGELOG.md"
2626

2727
# Patterns for the sections in the changelog corresponding to the versions.
2828
pat_curr="/^##\s\[$curr_ver\]/"
29-
pat_prev="/^##\s\[.+]/ && NR>3"
29+
# Match the previous version, skipping the 8 lines at the top.
30+
pat_prev="/^##\s\[.+]/ && NR>8"
3031
# Extract the section enclosed between the 2 headers and strip off the first
3132
# 2 and last 2 lines (one is blank and one contains the header `## [A.B.C]`).
3233
# Then, replace `-` with `*` and remove section headers.

0 commit comments

Comments
 (0)