Skip to content

Commit 20c6ba3

Browse files
authored
Section for backward-incompatible changes in the changelog (#8941)
In addition to the existing "fixes" and "implements" sections.
1 parent ff980e6 commit 20c6ba3

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

scripts/changelog/generate.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ echo "Building CHANGELOG"
4040
echo "**Highlighted features in TimescaleDB v${RELEASE_NEXT}**"
4141
echo "* "
4242
echo ""
43+
echo_changelog '**Backward-Incompatible Changes**' '^Backward-Incompatible Change:'
4344
echo_changelog '**Features**' '^Implements:'
4445
echo_changelog '**Bugfixes**' '^Fixes:'
4546
echo_gucs $RELEASE_PREVIOUS $RELEASE_BRANCH

scripts/changelog/template.rfc822

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
Backward-Incompatible Change: #NNNNN <one line description of the feature>
2+
13
Implements: #NNNNN <one line description of the feature>
24

35
Fixes: #NNNNN <one line description of the Issue>

scripts/check_changelog_format.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,12 @@ def get_referenced_issues(pr_number):
6969

7070
# Check if a line matches any of the specified patterns
7171
def is_valid_line(line):
72-
patterns = [r"^Fixes:\s*.*$", r"^Implements:\s*.*$", r"^Thanks:\s*.*$"]
72+
patterns = [
73+
r"^Fixes:\s*.*$",
74+
r"^Implements:\s*.*$",
75+
r"^Thanks:\s*.*$",
76+
r"^Backward-Incompatible Change:\s*.*$",
77+
]
7378
for pattern in patterns:
7479
if re.match(pattern, line):
7580
return True

0 commit comments

Comments
 (0)