You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: VERSIONING.md
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Versioning
2
2
3
3
## Auto Generated Version Examples
4
+
These are examples of how our configuration of [poetry-dynamic-versioning](https://github.com/mtkennerly/poetry-dynamic-versioning) will generate the version number.
5
+
4
6
If branch is not main and there are commits since last tag:
5
7
```
6
8
tux 0.0.0.dev2106+b731156.dynamicversioning
@@ -29,4 +31,16 @@ name^
29
31
30
32
## Scheme
31
33
We use PEP 440 for formatting our version numbers, however we use SemVer for the versioning scheme.
32
-
> Keep in mind you cannot use .dev(NUMBER) as it clashes with the auto generated versioning.
34
+
> Keep in mind you cannot use .dev(NUMBER) as it clashes with the auto generated versioning. (e.g 0.1.0rc1.dev1 is invalid and won't show up properly)
35
+
36
+
## SemVer Summary
37
+
A example in tux would be:
38
+
Given a version number MAJOR.MINOR.PATCH, increment the:
39
+
40
+
MAJOR version when you make changes that may need significant manual setup from the last version (example would be a web panel, config overhaul, major db changes)
41
+
MINOR version when you make changes that needs little to no manual interference (at most maybe tweaking a config value or updating the db)
42
+
PATCH version when you make changes that need no manual interference
43
+
44
+
You can add stuff like "0.1.0**rc1**" to mark small changes leading up to a release. (release candidates)
45
+
46
+
You do not need to stick to this absolutely all the time, this is a guideline on how to make your versioning.
0 commit comments