Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#### Pull Request Checklist
- [ ] Update `docs/release-notes/release-notes-next.md` if your PR contains
major features, breaking changes or bugfixes
- [ ] Add an entry to `docs/release-notes/release-notes-next.md` (required by
CI)
36 changes: 36 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,42 @@ env:
LITD_ITEST_BRANCH: master

jobs:
########################
# release notes
########################
release-notes:
name: Release Notes
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- name: git checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Check for a release note
env:
BASE_SHA: ${{ github.event.pull_request.base.sha }}
HEAD_SHA: ${{ github.event.pull_request.head.sha }}
RELEASE_NOTES_FILE: docs/release-notes/release-notes-next.md
run: |
if git diff --unified=0 "$BASE_SHA...$HEAD_SHA" -- \
"$RELEASE_NOTES_FILE" |
awk '
/^@@/ { in_hunk = 1; next }
in_hunk && /^\+/ {
line = substr($0, 2)
if (line ~ /[^[:space:]]/) found = 1
}
END { exit found ? 0 : 1 }
'
then
exit 0
fi

echo "::error file=$RELEASE_NOTES_FILE::Add a release note for this PR."
exit 1

########################
# commit message lint
########################
Expand Down
9 changes: 9 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,12 @@ the binding dependencies are the asset loop-out fields
`routerrpc.SendPaymentRequest.first_hop_custom_records` and
`lnrpc.Route.custom_channel_data` (lnd v0.18.4-beta), plus the sweep-batcher fee
floor `walletrpc.EstimateFeeResponse.min_relay_fee_sat_per_kw` (lnd v0.18.3-beta).

**6. Pull Request Release Notes:**

Every pull request must add at least one non-empty line to
`docs/release-notes/release-notes-next.md`. Before finishing any change intended
for a pull request, add a concise entry under the appropriate section (`New
Features`, `Breaking Changes`, `Bug Fixes`, or `Maintenance`). This applies to
all pull requests, including internal maintenance and documentation changes, and
is enforced by CI.
3 changes: 3 additions & 0 deletions docs/release-notes/release-notes-next.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,7 @@

#### Maintenance

* Added a CI gate and repository agent guidance requiring every pull request to
include a non-empty entry in the next release notes.

#### Contributors (Alphabetical Order)
Loading