Skip to content

Commit 661e5c2

Browse files
committed
RFC #76: Final touches.
1 parent 28091cd commit 661e5c2

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

text/0076-amaranth-boards-versioning-policy.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
- Start Date: (fill in with date at which the RFC is merged, YYYY-MM-DD)
1+
- Start Date: (fill in with date at which the RFC is merged, 2025-05-12)
22
- RFC PR: [amaranth-lang/rfcs#76](https://github.com/amaranth-lang/rfcs/pull/76)
3-
- Amaranth Issue: [amaranth-lang/amaranth#0000](https://github.com/amaranth-lang/amaranth/issues/0000)
3+
- Amaranth Issue: [amaranth-lang/amaranth#1595](https://github.com/amaranth-lang/amaranth/issues/1595)
44

55
# `amaranth-boards` versioning policy
66

@@ -21,6 +21,11 @@ Packages with direct (e.g. git) dependencies aren't allowed on PyPI, so by not p
2121
- Increment `y` and do a new release any time there's been done significant additions.
2222
- Increment `x`, reset `y` and do a new release any time there are breaking changes.
2323

24+
A breaking change is anything that requires manual intervention for code that previously worked fine.
25+
I.e. a change to a board file which previously had two pins incorrectly swapped would not be a breaking change; a change to names of resources across multiple boards would be.
26+
27+
This should be implemented by automatically releasing every commit to `main` whose HEAD message doesn't contain `[breaking change]` or `[breaking-change]` with a version like `v0.x.y` where `y` is the number of commits since the last breaking change, and automatically tagging every commit that does with a tag `v0.(x+1).0`.
28+
2429
## Drawbacks
2530
[drawbacks]: #drawbacks
2631

0 commit comments

Comments
 (0)