Skip to content

Commit 28091cd

Browse files
committed
RFC #76: amaranth-boards versioning policy.
1 parent 98c79d3 commit 28091cd

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
- Start Date: (fill in with date at which the RFC is merged, YYYY-MM-DD)
2+
- 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)
4+
5+
# `amaranth-boards` versioning policy
6+
7+
## Summary
8+
[summary]: #summary
9+
10+
Add a versioning policy for `amaranth-boards`.
11+
12+
## Motivation
13+
[motivation]: #motivation
14+
15+
Packages with direct (e.g. git) dependencies aren't allowed on PyPI, so by not publishing releases on PyPI, we're blocking downstream projects depending on `amaranth-boards` from publishing their releases on PyPi without having to do workarounds.
16+
17+
## Explanation
18+
[guide-level-explanation]: #guide-level-explanation
19+
20+
- Use a `0.x.y` versioning scheme.
21+
- Increment `y` and do a new release any time there's been done significant additions.
22+
- Increment `x`, reset `y` and do a new release any time there are breaking changes.
23+
24+
## Drawbacks
25+
[drawbacks]: #drawbacks
26+
27+
None.
28+
29+
## Rationale and alternatives
30+
[rationale-and-alternatives]: #rationale-and-alternatives
31+
32+
`amaranth-boards` is mainly a collection of independent board definitions where most changes consists of adding or updating definitions for one specific target.
33+
34+
Most changes will have none to limited impact on existing code, and a simple policy reducing friction for new additions and fixes is more useful than having a strict deprecation policy with regular major releases.
35+
36+
## Prior art
37+
[prior-art]: #prior-art
38+
39+
None.
40+
41+
## Unresolved questions
42+
[unresolved-questions]: #unresolved-questions
43+
44+
None.
45+
46+
## Future possibilities
47+
[future-possibilities]: #future-possibilities
48+
49+
None.

0 commit comments

Comments
 (0)