Skip to content

Commit 63ff76c

Browse files
authored
docs: updated CHANGELOG.md (#2031)
Removed the "Other changes" section as there is really no good reason to include details about changes that don't impact users. Other changes: - Added instructions for updating the CHANGELOG in a comment. - Fixed the commands for generating a list of merged PRs.
1 parent 8d5a14f commit 63ff76c

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

CHANGELOG.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,17 @@
55
This section lists changes that have a potential impact on users of RDFLib,
66
changes with no user impact are not included in this section.
77

8+
<!--
9+
Please add an entry for user facing changes in this section.
10+
11+
New changes should go at the bottom of the list but the placeholder should
12+
remain.
13+
14+
Non user-facing changes does not have to be recorded in the changelog. This
15+
includes changes to CI, testing, etc. These changes will show up in the "PRs
16+
merged since last release" section but they are somewhat irrelevant to users.
17+
-->
18+
819
<!--
920
CHANGE BARRIER is intended to reduce the potential for merge conflicts
1021
and will be removed for release.
@@ -47,7 +58,8 @@ and will be removed for release.
4758
<!-- -->
4859
<!-- -->
4960

50-
- Description of changes.
61+
- PLACEHOLDER.
62+
Description of changes.
5163
Closed [issue #....](https://github.com/RDFLib/rdflib/issues/).
5264
[PR #....](https://ichard26.github.io/next-pr-number/?owner=RDFLib&name=rdflib).
5365

@@ -57,21 +69,13 @@ and will be removed for release.
5769
<!-- -->
5870
<!-- -->
5971

60-
## Other changes
61-
62-
This section lists changes that have no impact on the users of RDFLib.
63-
64-
- ...
65-
Closed [issue #....](https://github.com/RDFLib/rdflib/issues/).
66-
[PR #....](https://ichard26.github.io/next-pr-number/?owner=RDFLib&name=rdflib).
67-
6872
## PRs merged since last release
6973

70-
<!-- This will be auto generated with
74+
<!-- This will be auto generated with:
7175
72-
gh search prs --repo RDFLib/rdflib --merged --base master --json assignees,author,authorAssociation,body,closedAt,commentsCount,createdAt,id,isLocked,isPullRequest,labels,number,repository,state,title,updatedAt,url --limit 1000 --jq '[.[] | select(.closedAt >= "2022-07-17T00:00:00Z")]' | jq '(. |= sort_by(.closedAt)) | reverse' > /var/tmp/merged-prs.json
76+
gh search prs --repo RDFLib/rdflib --merged --base master --json assignees,author,authorAssociation,body,closedAt,commentsCount,createdAt,id,isLocked,isPullRequest,labels,number,repository,state,title,updatedAt,url --limit 1000 --jq '[.[] | select(.closedAt >= "2022-07-17T00:00:00Z")]' | jq '(. |= sort_by(.closedAt)) | reverse' | tee /var/tmp/merged-prs.json
7377
74-
jq -r '.[] | [ .url, .title ] | @tsv' /var/tmp/merged-prs.json | head -n -3 | sort -r | awk -F$'\t' '(match($1, "^.*/([^/]+)$", matches)){printf("* %s\n [PR #%s](%s)\n", $2, matches[1], $1)}'
78+
jq -r '.[] | [ .url, .title ] | @tsv' /var/tmp/merged-prs.json | sort -r | awk -F$'\t' '(match($1, "^.*/([^/]+)$", matches)){printf("* %s\n [PR #%s](%s)\n", $2, matches[1], $1)}'
7579
7680
-->
7781

0 commit comments

Comments
 (0)