Skip to content

Commit 0e736bb

Browse files
RoasbeefRoasbeef
authored
Merge pull request #1679 from lightninglabs/release-notes-0-7-0-merged-prs
docs: add release notes template, add entries for v0.6.1 and v0.7.0
2 parents f1db7c9 + 24edadf commit 0e736bb

File tree

5 files changed

+265
-0
lines changed

5 files changed

+265
-0
lines changed

‎.github/workflows/main.yaml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,20 @@ jobs:
223223
- name: run format
224224
run: make fmt
225225

226+
########################
227+
# check PR updates release notes
228+
########################
229+
milestone-check:
230+
name: Check release notes updated
231+
runs-on: ubuntu-latest
232+
if: '!contains(github.event.pull_request.labels.*.name, ''no-changelog'')'
233+
steps:
234+
- name: Git checkout
235+
uses: actions/checkout@v4
236+
237+
- name: Release notes check
238+
run: scripts/check-release-notes.sh
239+
226240
########################
227241
# run unit tests
228242
########################

‎docs/release-notes/release-notes-0.6.1.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Release Notes
2+
- [Bug Fixes](#bug-fixes)
3+
- [Improvements](#improvements)
4+
- [Performance Improvements](#performance-improvements)
5+
- [Technical and Architectural Updates](#technical-and-architectural-updates)
6+
- [Code Health](#code-health)
7+
8+
# Bug Fixes
9+
10+
- Database errors are now [sanitized before being
11+
returned](https://github.com/lightninglabs/taproot-assets/pull/1630).
12+
13+
- [A potential deadlock in combination with `lnd`'s code hooks was fixed by
14+
making the message router
15+
non-blocking](https://github.com/lightninglabs/taproot-assets/pull/1652).
16+
17+
- [A bug in the multi-RFQ send logic was fixed that could previously lead to
18+
a panic](https://github.com/lightninglabs/taproot-assets/pull/1627).
19+
20+
- [An extra asset unit of tolerance was added to the invoice acceptor to fix
21+
MPP sharding
22+
issues](https://github.com/lightninglabs/taproot-assets/pull/1639).
23+
24+
# Improvements
25+
26+
## Performance Improvements
27+
28+
- A new cache for [asset meta information was
29+
added](https://github.com/lightninglabs/taproot-assets/pull/1650) that greatly
30+
improves the performance of the universe asset statistics call.
31+
32+
# Technical and Architectural Updates
33+
34+
## Code Health
35+
36+
- The compile time dependency version of `lnd` was bumped to `v0.19.2-beta` in
37+
[#1644](https://github.com/lightninglabs/taproot-assets/pull/1644).
38+
39+
# Contributors (Alphabetical Order)
40+
41+
- George Tsagkarelis
42+
- Oliver Gugger

‎docs/release-notes/release-notes-0.7.0.md

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Release Notes
2+
- [Bug Fixes](#bug-fixes)
3+
- [New Features](#new-features)
4+
- [Functional Enhancements](#functional-enhancements)
5+
- [RPC Additions](#rpc-additions)
6+
- [tapcli Additions](#tapcli-additions)
7+
- [Improvements](#improvements)
8+
- [Functional Updates](#functional-updates)
9+
- [RPC Updates](#rpc-updates)
10+
- [tapcli Updates](#tapcli-updates)
11+
- [Breaking Changes](#breaking-changes)
12+
- [Performance Improvements](#performance-improvements)
13+
- [Deprecations](#deprecations)
14+
- [Technical and Architectural Updates](#technical-and-architectural-updates)
15+
- [BIP/bLIP Spec Updates](#bipblip-spec-updates)
16+
- [Testing](#testing)
17+
- [Database](#database)
18+
- [Code Health](#code-health)
19+
- [Tooling and Documentation](#tooling-and-documentation)
20+
21+
# Bug Fixes
22+
23+
- A bug in the [syncer was fixed where IDs were compared
24+
incorrectly](https://github.com/lightninglabs/taproot-assets/pull/1610).
25+
26+
- [An integration test flake was
27+
fixed](https://github.com/lightninglabs/taproot-assets/pull/1651).
28+
29+
# New Features
30+
31+
## Functional Enhancements
32+
33+
- A series of PRs added support for creating and verifying grouped asset supply
34+
commitments:
35+
- https://github.com/lightninglabs/taproot-assets/pull/1602
36+
- https://github.com/lightninglabs/taproot-assets/pull/1464
37+
- https://github.com/lightninglabs/taproot-assets/pull/1589
38+
- https://github.com/lightninglabs/taproot-assets/pull/1507
39+
- https://github.com/lightninglabs/taproot-assets/pull/1508
40+
- https://github.com/lightninglabs/taproot-assets/pull/1638
41+
- https://github.com/lightninglabs/taproot-assets/pull/1643
42+
- https://github.com/lightninglabs/taproot-assets/pull/1655
43+
- https://github.com/lightninglabs/taproot-assets/pull/1554
44+
45+
- Assets burned before `v0.6.0` were not yet added to the table that contains
46+
all burn events (which can be listed with the `ListBurns` RPC). A [database
47+
migration](https://github.com/lightninglabs/taproot-assets/pull/1612) was
48+
added that retroactively inserts all burned assets into that table.
49+
50+
## RPC Additions
51+
52+
- The [price oracle RPC calls now have an intent, optional peer ID and metadata
53+
field](https://github.com/lightninglabs/taproot-assets/pull/1677) for more
54+
context to help the oracle return an optimal asset price rate. The intent
55+
distinguishes between paying an asset invoice vs. creating an asset invoice
56+
and the three distinct phases of those two processes: Asking for a price hint
57+
before creating the request, requesting an actual price for a swap and
58+
validating a price returned from a peer. See `priceoraclerpc.Intent` in the
59+
[API
60+
docs](https://lightning.engineering/api-docs/api/taproot-assets/price-oracle/query-asset-rates/#priceoraclerpcintent)
61+
for more information on the different values and their meaning.
62+
- The `SendPayment`, `AddInvoice` and `DecodeAssetPayReq` RPCs now have a [new
63+
`price_oracle_metadata` field the user can specify to send additional metadata
64+
to a price oracle](https://github.com/lightninglabs/taproot-assets/pull/1677)
65+
when requesting quotes. The field can contain optional user or authentication
66+
information that helps the price oracle to decide on the optimal price rate to
67+
return.
68+
69+
## tapcli Additions
70+
71+
# Improvements
72+
73+
## Functional Updates
74+
75+
## RPC Updates
76+
77+
## tapcli Updates
78+
79+
## Code Health
80+
81+
- A series of PRs was created that refactored the send and funding logic in
82+
preparation for supporting grouped asset on-chain TAP addresses:
83+
- https://github.com/lightninglabs/taproot-assets/pull/1502
84+
- https://github.com/lightninglabs/taproot-assets/pull/1611
85+
- https://github.com/lightninglabs/taproot-assets/pull/1512
86+
- https://github.com/lightninglabs/taproot-assets/pull/1614
87+
- https://github.com/lightninglabs/taproot-assets/pull/1621
88+
- https://github.com/lightninglabs/taproot-assets/pull/1658
89+
90+
- The compile time dependency version of `lnd` was bumped to `v0.19.2-beta` in
91+
[#1657](https://github.com/lightninglabs/taproot-assets/pull/1657).
92+
93+
- All [`lndclient` wrapper services were moved to their own `lndservices` sub
94+
package](https://github.com/lightninglabs/taproot-assets/pull/1668).
95+
96+
## Breaking Changes
97+
98+
## Performance Improvements
99+
100+
## Deprecations
101+
102+
# Technical and Architectural Updates
103+
104+
## BIP/bLIP Spec Updates
105+
106+
## Testing
107+
108+
## Database
109+
110+
## Code Health
111+
112+
## Tooling and Documentation
113+
114+
- [Two new sequence diagrams were
115+
added](https://github.com/lightninglabs/taproot-assets/pull/1677) to the [RFQ
116+
section of the RFQ and decimal display
117+
document](https://github.com/lightninglabs/taproot-assets/blob/main/docs/rfq-and-decimal-display.md#rfq)
118+
that show the interaction between `tapd` and its price oracle for the two
119+
different flows.
120+
121+
- Integration tests can [now run in
122+
parallel](https://github.com/lightninglabs/taproot-assets/pull/1641) which
123+
saves a lot of cumulative CI minutes in GitHub Actions.
124+
125+
# Contributors (Alphabetical Order)
126+
127+
- Oliver Gugger

‎docs/release-notes/release-notes-template.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Release Notes
2+
- [Bug Fixes](#bug-fixes)
3+
- [New Features](#new-features)
4+
- [Functional Enhancements](#functional-enhancements)
5+
- [RPC Additions](#rpc-additions)
6+
- [tapcli Additions](#tapcli-additions)
7+
- [Improvements](#improvements)
8+
- [Functional Updates](#functional-updates)
9+
- [RPC Updates](#rpc-updates)
10+
- [tapcli Updates](#tapcli-updates)
11+
- [Breaking Changes](#breaking-changes)
12+
- [Performance Improvements](#performance-improvements)
13+
- [Deprecations](#deprecations)
14+
- [Technical and Architectural Updates](#technical-and-architectural-updates)
15+
- [BIP/bLIP Spec Updates](#bipblip-spec-updates)
16+
- [Testing](#testing)
17+
- [Database](#database)
18+
- [Code Health](#code-health)
19+
- [Tooling and Documentation](#tooling-and-documentation)
20+
21+
# Bug Fixes
22+
23+
# New Features
24+
25+
## Functional Enhancements
26+
27+
## RPC Additions
28+
29+
## tapcli Additions
30+
31+
# Improvements
32+
33+
## Functional Updates
34+
35+
## RPC Updates
36+
37+
## tapcli Updates
38+
39+
## Code Health
40+
41+
## Breaking Changes
42+
43+
## Performance Improvements
44+
45+
## Deprecations
46+
47+
# Technical and Architectural Updates
48+
49+
## BIP/bLIP Spec Updates
50+
51+
## Testing
52+
53+
## Database
54+
55+
## Code Health
56+
57+
## Tooling and Documentation
58+
59+
# Contributors (Alphabetical Order)

‎scripts/check-release-notes.sh

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/bin/bash
2+
3+
set -e
4+
5+
# Extract the PR number which is stored in the $GITHUB_REF env variable. The
6+
# format of the string stored in the variable is: refs/pull/:PRNUMBER/merge.
7+
PR_NUMBER=$(echo $GITHUB_REF | awk 'BEGIN { FS = "/" } ; { print $3 }')
8+
9+
# If this is a PR being merged into the main repo, then the PR number will
10+
# actually be "master" here, so we'll ignore this case, and assume that in
11+
# order for it to be merged it had to pass the check in its base branch. If
12+
# we're trying to merge this with the Merge Queue, then the PR number will be
13+
# "gh-readonly-queue" instead.
14+
if [[ $PR_NUMBER == "master" ]] || [[ $PR_NUMBER == "gh-readonly-queue" ]]; then
15+
exit 0
16+
fi
17+
18+
# Ensure that the PR number at least shows up in the release notes folder under
19+
# one of the contained milestones.
20+
if ! grep -r -q "lightninglabs/taproot-assets/pull/$PR_NUMBER" docs/release-notes; then
21+
echo "PR $PR_NUMBER didn't update release notes"
22+
exit 1
23+
fi

0 commit comments

Comments
 (0)