From 48b00899ead85e267df5fa7473c4c87e8caef6ff Mon Sep 17 00:00:00 2001 From: patdyn Date: Fri, 5 Jul 2024 11:47:32 +0200 Subject: [PATCH] [Skip-CI] Format, remove unnecessary details --- doc/Upgrading.md | 99 ++++++++++++++++++++++++------------------------ 1 file changed, 49 insertions(+), 50 deletions(-) diff --git a/doc/Upgrading.md b/doc/Upgrading.md index dc3639c..6664633 100644 --- a/doc/Upgrading.md +++ b/doc/Upgrading.md @@ -17,60 +17,60 @@ kubectl scale deployment forgejo --replicas=1 ``` Logging into the admin account should now show the new version. - You may want to update your c4k-forgejo resources to reflect the changes made on the cluster. ## Upgrading from 1.19 ### Config related issues with c4k-forgejo v3.2.2 -- oauth2: ENABLED instead of ENABLE - - `FORGEJO__oauth2__ENABLED: "true"` -- 2024/07/02 13:16:17 ...g/config_provider.go:329:deprecatedSetting() [E] Deprecated config option `[log]` `ROUTER` present. Use `[log]` `logger.router.MODE` i - nstead. This fallback will be/has been removed in 1.21 - - `FORGEJO__log_0x2E_logger_0x2E_router__MODE: console, file` -- 2024/07/02 13:16:17 ...g/config_provider.go:329:deprecatedSetting() [E] Deprecated config option `[service]` `EMAIL_DOMAIN_WHITELIST` present. Use `[service] - ` `EMAIL_DOMAIN_ALLOWLIST` instead. This fallback will be/has been removed in 1.21 - - `FORGEJO__service__EMAIL_DOMAIN_ALLOWLIST:` -- 2024/07/02 13:16:17 ...g/config_provider.go:329:deprecatedSetting() [E] Deprecated config option `[mailer]` `MAILER_TYPE` present. Use `[mailer]` `PROTOCOL` - instead. This fallback will be/has been removed in v1.19.0 - - ...es/setting/mailer.go:133:loadMailerFrom() [E] Deprecated fallback `[mailer]` `PROTOCOL = smtp+startls` present. Use `[mailer]` `PROTOCOL = smtp+starttls`` instead. This fallback will be removed in v1.19.0 - - `FORGEJO__mailer__PROTOCOL: smtp+starttls` - - starttls instead of startls - -### Breaking Changes +These errors show in the log, when just upgrading to forgejo v7.0.4 from 1.19 without changing the config. +The related config options are listed below the errors. -#### 1.19.3:Aktueller Stand +- Oauth2: ENABLED instead of ENABLE + - `FORGEJO__oauth2__ENABLED: "true"` +- [E] Deprecated config option `[log]` `ROUTER` present. Use `[log]` `logger.router.MODE` instead. + - `FORGEJO__log_0x2E_logger_0x2E_router__MODE: console, file` +- [E] Deprecated config option `[service]` `EMAIL_DOMAIN_WHITELIST` present. Use `[service] + ` `EMAIL_DOMAIN_ALLOWLIST` instead. + - `FORGEJO__service__EMAIL_DOMAIN_ALLOWLIST: YOUR_ALLOW_LIST` +- [E] Deprecated config option `[mailer]` `MAILER_TYPE` present. Use `[mailer]` `PROTOCOL` + instead. +- [E] Deprecated fallback `[mailer]` `PROTOCOL = smtp+startls` present. Use `[mailer]` `PROTOCOL = smtp+starttls`` instead. + - `FORGEJO__mailer__PROTOCOL: smtp+starttls` + +### Breaking Changes since 1.19 + +#### 1.19.3 & 1.19.4: Version installed by c4k-forgejo v3.2.2 #### 1.20.1-0: Breaking https://codeberg.org/forgejo/forgejo/src/branch/forgejo/RELEASE-NOTES.md#1-20-1-0 ##### app.ini -- check [queue] section - n/e -- check [repository.editor] - n/e -- check [storage] - n/e -- check ssh_keygen_path in app.ini - n/e -- is WORK_PATH set? Or app.ini writeable by forgejo server user? - - 1. no - - 2. probably +- Check [queue] section - n/e +- Check [repository.editor] - n/e +- Check [storage] - n/e +- Check ssh_keygen_path in app.ini - n/e +- Is WORK_PATH set? Or app.ini writeable by forgejo server user? + - 1. No + - 2. Yes - If not, it shows in the logs starting with: `Unable to update WORK_PATH` - - Also ssh pushing will likely fail - *test ssh* - - no errors on test instance -- set logger.router.mode as described in environment-to-ini - - see: https://codeberg.org/forgejo/forgejo/src/branch/forgejo/contrib/environment-to-ini -- check [git.reflog] and maybe move to [git.config] - n/e -- check [indexer], [mailer], [repository] - n/e + - Also ssh pushing will likely fail + - *test ssh* +- Set logger.router.mode as described in environment-to-ini + - See: https://codeberg.org/forgejo/forgejo/src/branch/forgejo/contrib/environment-to-ini +- Check [git.reflog] and maybe move to [git.config] - n/e +- Check [indexer], [mailer], [repository] - n/e ##### tokens -- scoped and personal access tokens were refactored - - scope may change, if we have tokens they should be rotated +- Scoped and personal access tokens were refactored + - Scope may change, if we have tokens they should be rotated #### 1.21.1-0: https://codeberg.org/forgejo/forgejo/src/branch/forgejo/RELEASE-NOTES.md#1-21-1-0 ##### custom themes -- move to `custom/public/assets/` +- Move to `custom/public/assets/` ##### git branches @@ -78,58 +78,57 @@ You may want to update your c4k-forgejo resources to reflect the changes made on ##### db - mysql -- we use postgres +- c4k uses postgres ##### ssh server -- host cert used for auth? +- We don't use host cert used for auth ##### ssh keys -- all team members need to check their key length, now 3072 +- All users need to check their key length, now 3072 ##### tokens -- finer restrictions might now return 404 errors on users in certain teams with certain restrictions +- Finer restrictions might now return 404 errors on users tokens in certain teams with certain restrictions #### 7.0.0: https://codeberg.org/forgejo/forgejo/src/branch/forgejo/RELEASE-NOTES.md#7-0-0 ##### webhooks -- do we use webhooks? +- Do we use webhooks? ##### db -- psql min ver is 12 - should be fine right? +- Psql min ver is 12, c4k-common uses 14+ ##### api -- benutzen wir: - - [/repos/{owner}/{repo}/releases](https://code.forgejo.org/api/swagger/#/repository/repoListReleases) - - [/repos/{owner}/{repo}/push_mirrors](https://code.forgejo.org/api/swagger/#/repository/repoListPushMirrors) - - Application profiling +- [/repos/{owner}/{repo}/releases](https://code.forgejo.org/api/swagger/#/repository/repoListReleases) +- [/repos/{owner}/{repo}/push_mirrors](https://code.forgejo.org/api/swagger/#/repository/repoListPushMirrors) +- Application profiling ##### repos -- do we have repo descriptions? +- Do we have repo descriptions? - https://codeberg.org/forgejo/forgejo/commit/1075ff74b5050f671c5f9824ae39390230b3c85d ##### app.ini -- check [ui] - n/e +- Check [ui] - n/e ### Vor dem Upgrade -- host cert used for auth? - no -- do we use webhooks? - no -- do we use: +- Host cert used for auth? - no +- Do we use webhooks? - no +- Do we use: - [/repos/{owner}/{repo}/releases - repoListReleases](https://code.forgejo.org/api/swagger/#/repository/repoListReleases) - no - In the ListReleases, the `per_page` parameter has been decoupled from the `limit` parameter, we do not use the repoListReleases endpoint - In the `ArtifactDeploymentApi` in dda-devops-build we only use the `POST` method - The respective endpoint is [repoCreateRelease](https://code.forgejo.org/api/swagger/#/repository/repoCreateRelease) - [`/repos/{owner}/{repo}/push_mirrors`](https://code.forgejo.org/api/swagger/#/repository/repoListPushMirrors) - no - Application profiling - no -- do we have repo descriptions? - yes +- Do we have repo descriptions? - yes - There is now a sanitizer that only allows links, emphasis, code and emojis - See: https://codeberg.org/forgejo/forgejo/commit/1075ff74b5050f671c5f9824ae39390230b3c85d - Our repository descriptions are mostly plaintext and links @@ -137,7 +136,7 @@ You may want to update your c4k-forgejo resources to reflect the changes made on ### Upgrade plan TEST indicates actions that only apply to the test server and are ignored in PROD. -PROD indicates actions that only apply to the test server and are ignored in TEST. +PROD indicates actions that only apply to the prod server and are ignored in TEST. See also the overview for upgrading: https://forgejo.org/docs/latest/admin/upgrade/ - Set up Forgejo server with c4k-forgejo v3.2.2