gitea/helm-gitea
Fork 169
Code Issues 54 Pull Requests 11 Actions 2 Releases 103 Activity

Update README with new dependency versioning approach #578

Merged
justusbunsi merged 5 commits from readme-dep-versioning into main 2023-12-13 16:56:02 +00:00
Conversation 3 Commits 5 Files Changed 1 +53 -5
pat-s commented 2023-12-04 20:23:38 +00:00
Collaborator
Copy Link

As discussed in gitea/helm-chart#572.

Also added a bit more context and updates to the overall "Dependencies" sections.

As discussed in https://gitea.com/gitea/helm-chart/issues/572. Also added a bit more context and updates to the overall "Dependencies" sections.
pat-s added the
kind
docs
 label 2023-12-04 20:23:38 +00:00
pat-s added 1 commit 2023-12-04 20:23:38 +00:00
update README with dependency versioning approach
Some checks failed
check-and-test / check-and-test (pull_request) Failing after 29s
Details
5446273310
pat-s requested review from justusbunsi 2023-12-04 20:23:47 +00:00
pat-s added 1 commit 2023-12-04 20:29:15 +00:00
lint
All checks were successful
check-and-test / check-and-test (pull_request) Successful in 29s
Details
415bdaa4a9
pat-s commented 2023-12-11 07:59:30 +00:00
Author
Collaborator
Copy Link

@justusbunsi Any comments from your side?

@justusbunsi Any comments from your side?
justusbunsi requested changes 2023-12-11 17:34:49 +00:00
justusbunsi left a comment
Contributor
Copy Link

Sorry for not reviewing earlier. Last week was weird wrt my availability.

Sorry for not reviewing earlier. Last week was weird wrt my availability.
README.md Outdated
@@ -82,2 +85,2 @@
Gitea can be run with an external database and cache.
This chart provides those dependencies, which can be enabled, or disabled via configuration.
Gitea is most performant when run with an external database and cache.
This chart provides those dependencies as sub-chart dependencies.
justusbunsi commented 2023-12-11 17:24:17 +00:00
Contributor
Copy Link

Don't repeat "dependencies".

- This chart provides those dependencies as sub-chart dependencies. + This chart provides those dependencies via sub-charts.
Don't repeat "dependencies". ```diff - This chart provides those dependencies as sub-chart dependencies. + This chart provides those dependencies via sub-charts. ```
👍 1
justusbunsi marked this conversation as resolved
README.md Outdated
@@ -89,0 +105,4 @@
The reasoning behind this is that new users of the chart will start with the most recent sub-chart dependency versions.
If you want to stay on an older appVersion of a sub-chart dependency (e.g. PostgreSQL), you need to override the image tag in your `values.yaml` file.
In fact, we recommend to do so right from the start to be independent of major sub-chart dependency changes as they are released.
justusbunsi commented 2023-12-11 17:27:00 +00:00
Contributor
Copy Link

This should be more eye-catching. Maybe by using the quote syntax? Although, this would break the text flow. 🤔

This should be more eye-catching. Maybe by using the quote syntax? Although, this would break the text flow. 🤔
pat-s commented 2023-12-12 13:52:34 +00:00
Author
Collaborator
Copy Link

I've used a **Note** to make it stand out more.

I've used a `**Note**` to make it stand out more.
👍 1
justusbunsi marked this conversation as resolved
README.md Outdated
@@ -89,0 +106,4 @@
If you want to stay on an older appVersion of a sub-chart dependency (e.g. PostgreSQL), you need to override the image tag in your `values.yaml` file.
In fact, we recommend to do so right from the start to be independent of major sub-chart dependency changes as they are released.
There is no need to update to every new PostgreSQL major version - you can happily skip some and do a larger update every few years.
justusbunsi commented 2023-12-11 17:22:44 +00:00
Contributor
Copy Link

I wouldn't be specific about when to update. Every few years seems a bit long. 😉

- There is no need to update to every new PostgreSQL major version - you can happily skip some and do a larger update every few years. + There is no need to update to every new PostgreSQL major version - you can happily skip some and do larger updates when you are ready for them.
I wouldn't be specific about when to update. Every few years seems a bit long. 😉 ```diff - There is no need to update to every new PostgreSQL major version - you can happily skip some and do a larger update every few years. + There is no need to update to every new PostgreSQL major version - you can happily skip some and do larger updates when you are ready for them. ```
👍 1
pat-s marked this conversation as resolved
README.md Outdated
@@ -89,0 +108,4 @@
In fact, we recommend to do so right from the start to be independent of major sub-chart dependency changes as they are released.
There is no need to update to every new PostgreSQL major version - you can happily skip some and do a larger update every few years.
We recommend to use a rolling tag like `:<majorVersion>-debian-11` to incorporate minor and patch updates for the respective major version as they are released.
justusbunsi commented 2023-12-11 17:29:26 +00:00
Contributor
Copy Link

We probably shouldn't refer to a OS-specific image. Otherwise, we should update the reference now and then. Maybe simply referring to :<majorVersion>?

We probably shouldn't refer to a OS-specific image. Otherwise, we should update the reference now and then. Maybe simply referring to `:<majorVersion>`?
pat-s commented 2023-12-12 13:56:27 +00:00
Author
Collaborator
Copy Link

This is the image the Bitnami chart uses. I would prefer to link users to it to avoid them using the official PG image - for compatibility with the bitnami chart. There are reasons why Bitnami maintains their own PG images.

We could variabalize the 11 but I wouldn't want to be too generic here with the image recommendation.

This is the image the Bitnami chart uses. I would prefer to link users to it to avoid them using the official PG image - for compatibility with the bitnami chart. There are reasons why Bitnami maintains their own PG images. We could variabalize the `11` but I wouldn't want to be too generic here with the image recommendation.
justusbunsi commented 2023-12-12 17:41:49 +00:00
Contributor
Copy Link

This is the image the Bitnami chart uses. I would prefer to link users to it to avoid them using the official PG image - for compatibility with the bitnami chart. There are reasons why Bitnami maintains their own PG images.

Absolutely. We should prevent any confusion. We could directly link to the DockerHub tag list site of the respective pgsql image. There is also the :<majorVersion> tag available.

> This is the image the Bitnami chart uses. I would prefer to link users to it to avoid them using the official PG image - for compatibility with the bitnami chart. There are reasons why Bitnami maintains their own PG images. Absolutely. We should prevent any confusion. We could directly link to the DockerHub tag list site of the respective pgsql image. There is also the `:<majorVersion>` tag available. - HA: https://hub.docker.com/r/bitnami/postgresql-repmgr/tags - Non-HA: https://hub.docker.com/r/bitnami/postgresql/tags
justusbunsi marked this conversation as resolved
README.md Outdated
@@ -89,0 +114,4 @@
Please double-check the image repository and available tags in the sub-chart:
- [PostgreSQL-HA](https://github.com/bitnami/charts/blob/main/bitnami/postgresql-ha/values.yaml#L106-L107)
- [Redis Cluster](https://github.com/bitnami/charts/blob/d6059e1cfa130e3f206976c412ee41c69532ed2f/bitnami/redis-cluster/values.yaml#L75-L76)
justusbunsi commented 2023-12-11 17:32:42 +00:00
Contributor
Copy Link

Intentional to use the permalink for redis-cluster but the main branch for pgsql-ha?
If not, this is the permalink for pgsql-ha: https://github.com/bitnami/charts/blob/b51288a469c1e42dac2ee2b3f26f1951eebf741f/bitnami/postgresql-ha/values.yaml#L106-L107

Intentional to use the permalink for redis-cluster but the main branch for pgsql-ha? If not, this is the permalink for pgsql-ha: `https://github.com/bitnami/charts/blob/b51288a469c1e42dac2ee2b3f26f1951eebf741f/bitnami/postgresql-ha/values.yaml#L106-L107`
pat-s commented 2023-12-12 13:57:18 +00:00
Author
Collaborator
Copy Link

Good catch. Not intentional. I think the the dynamic link is better here. Yes, line numbers might change but linking to an old version might also confuse users.

Good catch. Not intentional. I think the the dynamic link is better here. Yes, line numbers might change but linking to an old version might also confuse users.
justusbunsi marked this conversation as resolved
README.md Outdated
@@ -1054,0 +1091,4 @@
- Update PostgreSQL sub-chart dependencies to appVersion 16.x
- Update to sub-charts versioning approach: Users are encouraged to pin the version tag of the sub-chart dependencies to a major appVersion.
This avoids issues during chart upgrades and allows to incorporate new sub-chart versions as they come in. Please see the new [README section describing the versioning approach for sub-chart versions](#dependency-versioning).
justusbunsi commented 2023-12-11 17:30:26 +00:00
Contributor
Copy Link
- ... as they come in. ... + ... as they are released. ...
```diff - ... as they come in. ... + ... as they are released. ... ```
justusbunsi marked this conversation as resolved
pat-s added 1 commit 2023-12-12 14:00:15 +00:00
address comments
All checks were successful
check-and-test / check-and-test (pull_request) Successful in 32s
Details
a9969002e2
pat-s added 1 commit 2023-12-13 08:25:11 +00:00
use dockerhub links
All checks were successful
check-and-test / check-and-test (pull_request) Successful in 31s
Details
462ece0cde
justusbunsi approved these changes 2023-12-13 16:55:05 +00:00
justusbunsi left a comment
Contributor
Copy Link

LGTM 👍

LGTM 👍
justusbunsi added 1 commit 2023-12-13 16:55:09 +00:00
Merge branch 'main' into readme-dep-versioning
All checks were successful
check-and-test / check-and-test (pull_request) Successful in 31s
Details
ac49bc40ee
justusbunsi merged commit ff932a0bf9 into main 2023-12-13 16:56:02 +00:00
justusbunsi deleted branch readme-dep-versioning 2023-12-13 16:56:03 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
justusbunsi
Labels
Clear labels
has
backport
in progress
invalid
kind
breaking
kind
bug
kind
build
kind
dependency
kind
deployment
kind
docs
kind
enhancement
kind
feature
kind
lint
kind
proposal
kind
question
kind
refactor
kind
security
kind
testing
kind
translation
kind
ui
need
backport
priority
critical
priority
low
priority
maybe
priority
medium
reviewed
duplicate
reviewed
invalid
reviewed
wontfix
skip-changelog
status
blocked
status
needs-feedback
status
needs-reviews
status
wip
upstream
gitea
upstream
other
workaround
No Label
kind
docs
Milestone
No items
No Milestone
Assignees
Clear assignees
42wim 6543 a1012112796 Akkuman appleboy axifive betacat0 blumia bwko caicandong ChristopherHX DaanSelen davidsvantesson delvh denyskon fuxiaohei gary-kim garymoon giteabot guillep2k HesterG hiifong jaqra jolheiser jonasfranz jpraet kdumontnu kemzeb kerwin612 khmarbaise KN4CK3R kolaente lafriks lng2020 lotherk luhahn lunny mrsdizzie noerw pat-s puni9869 renovate-bot richmahn rossigee sapk screenshots sillyguodong silverwind smartclip_tim strk tboerger techknowlogick TheFox0x7 tobiasbp typeless volker.raschek wolfogre wxiaoguang yardenshoham yp05327 zeripath Zettat123
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: gitea/helm-gitea#578
No description provided.
Delete Branch "readme-dep-versioning"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?