Add section describing versioning and update policy #347

Merged
techknowlogick merged 13 commits from pat-s/helm-chart:update-policy into main 2023-03-08 17:14:34 +00:00
Member

After recent discussions in Discord.

Feel free to modify as needed!

After recent discussions in Discord. Feel free to modify as needed!
pat-s added 1 commit 2022-08-21 07:29:48 +00:00
add section describing versioning and update policy
Some checks failed
continuous-integration/drone/pr Build is failing
46a0ae5e03
pat-s requested review from justusbunsi 2022-08-21 07:29:59 +00:00
justusbunsi reviewed 2022-08-21 12:28:54 +00:00
README.md Outdated
@ -14,0 +19,4 @@
The chart aims to follow Gitea's releases closely.
There might be times when the chart is behind the latest Gitea release.
This might be caused by different reasons, most often due to time constraints of the maintainers (remember, all work here is done voluntarily in the spare time of people).
If you're eager to use the latest Gitea version earlier than this chart catches up, then change the tag in `values.yml` to the latest Gitea version.
Member
- values.yml
+ values.yaml
```diff - values.yml + values.yaml ```
justusbunsi marked this conversation as resolved
README.md Outdated
@ -14,0 +22,4 @@
If you're eager to use the latest Gitea version earlier than this chart catches up, then change the tag in `values.yml` to the latest Gitea version.
Note that besides the exact Gitea version one can also use the `:1` tag to automatically follow the latest Gitea version.
This should be combined with `image.pullPolicy: "Always"`.
Note that using the `:1` will also automatically jump to new minor release (e.g. from 1.13 to 1.14) which may eventually cause incompatibilities if major changes happened between these versions.
Member

Do we speak of minor version bump or major version bump between 1.13 to 1.14?

I am thinking of the naming for semver major.minor.path but am not sure what's correct in the context of Gitea versioning.

Do we speak of minor version bump or major version bump between 1.13 to 1.14? I am thinking of the naming for semver `major.minor.path` but am not sure what's correct in the context of Gitea versioning.
Author
Member

Gitea doesn't strictly follow semantic versioning as breaking changes do not increase the major version.
So in Gitea's case "minor" version bumps are actually "major". This is why I added the example to make it explicit and explain this case in more detail.

I'd also refer to it as "minor" as this is what is commonly used for the x.y.z logic. But I also see that others might do different. I think we can't discuss Gitea's general versioning approach here :D

How would you (re)phrase it?

Gitea doesn't strictly follow semantic versioning as breaking changes do not increase the major version. So in Gitea's case "minor" version bumps are actually "major". This is why I added the example to make it explicit and explain this case in more detail. I'd also refer to it as "minor" as this is what is commonly used for the x.y.z logic. But I also see that others might do different. I think we can't discuss Gitea's general versioning approach here :D How would you (re)phrase it?
Member

Probably exactly how you explained.

Gitea doesn't strictly follow [semantic versioning](https://semver.org/#summary) as breaking changes do not increase the major version. So in Gitea's case "minor" version bumps are actually "major".

as an addition to the sentence "Note that using the :1 will also...."

Probably exactly how you explained. ``` Gitea doesn't strictly follow [semantic versioning](https://semver.org/#summary) as breaking changes do not increase the major version. So in Gitea's case "minor" version bumps are actually "major". ``` as an addition to the sentence "Note that using the `:1` will also...."
pat-s marked this conversation as resolved
README.md Outdated
@ -14,0 +24,4 @@
This should be combined with `image.pullPolicy: "Always"`.
Note that using the `:1` will also automatically jump to new minor release (e.g. from 1.13 to 1.14) which may eventually cause incompatibilities if major changes happened between these versions.
Though most often no issues will encountered and the chart maintainers aim to communicate early if this would be the case.
You might
Member

Loose end?

Loose end?
Author
Member

Good catch!

Good catch!
justusbunsi marked this conversation as resolved
pat-s added 2 commits 2022-08-21 14:17:17 +00:00
yml -> yaml
Some checks failed
continuous-integration/drone/pr Build is failing
24c089981b
pat-s added 1 commit 2022-09-07 06:50:51 +00:00
Merge branch 'main' into update-policy
Some checks failed
continuous-integration/drone/pr Build is failing
b12ffa1d42
Author
Member

blocked by #355

blocked by #355
pat-s added 1 commit 2022-09-25 19:35:25 +00:00
Merge branch 'main' into update-policy
Some checks failed
continuous-integration/drone/pr Build is failing
a6f2d9f3a8
pat-s added 3 commits 2022-09-25 20:19:29 +00:00
pat-s added 1 commit 2022-09-25 20:26:42 +00:00
mention semantic versioning policy
All checks were successful
continuous-integration/drone/pr Build is passing
5af6a43b22
pat-s requested review from luhahn 2022-09-25 20:27:19 +00:00
pat-s requested review from lunny 2022-09-25 20:27:28 +00:00
pat-s added 1 commit 2023-03-07 16:50:53 +00:00
Merge branch 'main' into update-policy
All checks were successful
continuous-integration/drone/pr Build is passing
13779f1832
Author
Member

@justusbunsi Can we merge here?

@justusbunsi Can we merge here?
techknowlogick reviewed 2023-03-07 22:22:07 +00:00
README.md Outdated
@ -14,0 +14,4 @@
## Update and versioning policy
The Gitea helm chart versioning does not follow Gitea's versioning.
The latest chart version can be looked up in [https://dl.gitea.io/charts](https://dl.gitea.io/charts) or in the [repository releases](https://gitea.com/gitea/helm-chart/releases).

Can you use dl.gitea.com instead of the .io due to the recent CDN changes?

Can you use dl.gitea.com instead of the .io due to the recent CDN changes?
techknowlogick marked this conversation as resolved
README.md Outdated
@ -14,0 +24,4 @@
This should be combined with `image.pullPolicy: "Always"`.
Important: Using the `:1` will also automatically jump to new minor release (e.g. from 1.13 to 1.14) which may eventually cause incompatibilities if major/breaking changes happened between these versions.
This is due to Gitea not strictly following [semantic versioning](https://semver.org/#summary) as breaking changes do not increase the major version.
I.e., "minor" version bumps are actually "major".

Can you use considered instead of actually?

Can you use `considered` instead of `actually`?
techknowlogick marked this conversation as resolved
pat-s added 2 commits 2023-03-08 08:29:33 +00:00
lunny approved these changes 2023-03-08 15:21:47 +00:00
justusbunsi approved these changes 2023-03-08 15:34:37 +00:00
justusbunsi left a comment
Member

LGTM

LGTM
justusbunsi added 1 commit 2023-03-08 15:35:29 +00:00
Merge branch 'main' into update-policy
All checks were successful
continuous-integration/drone/pr Build is passing
9aa493d04a
Member

@techknowlogick Anything left from your side?

@techknowlogick Anything left from your side?
techknowlogick approved these changes 2023-03-08 17:14:24 +00:00
techknowlogick merged commit 452aeadddf into main 2023-03-08 17:14:34 +00:00
Sign in to join this conversation.
No description provided.