Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inconsistent naming of OAuth 2.0 ENABLE setting #28951

Merged
merged 2 commits into from Jan 28, 2024

Conversation

wackbyte
Copy link
Contributor

@wackbyte wackbyte commented Jan 27, 2024

Renames it to ENABLED to be consistent with other settings and deprecates it.

I believe this change is necessary because other setting groups such as attachment, cors, mailer, etc. have an ENABLED setting, but oauth2 is the only one with an ENABLE setting, which could cause confusion for users.

This is no longer a breaking change because ENABLE has been set as deprecated and as an alias to ENABLED.

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jan 27, 2024
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jan 27, 2024
@yardenshoham yardenshoham added the pr/breaking Merging this PR means builds will break. Needs a description what exactly breaks, and how to fix it! label Jan 27, 2024
@yardenshoham
Copy link
Member

Do we support aliases? Maybe we can make this non-breaking.

@pull-request-size pull-request-size bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 27, 2024
@wackbyte
Copy link
Contributor Author

I read some of the other settings modules and learned that there's a pattern to deprecating and aliasing settings, so this PR is no longer breaking.

@yardenshoham yardenshoham added type/deprecation Previously provided functionality is removed and removed pr/breaking Merging this PR means builds will break. Needs a description what exactly breaks, and how to fix it! labels Jan 27, 2024
modules/setting/oauth2.go Outdated Show resolved Hide resolved
Renames it to `ENABLED` to be consistent with other settings and deprecates it.
@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jan 27, 2024
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jan 27, 2024
@yardenshoham yardenshoham added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jan 28, 2024
@lunny lunny enabled auto-merge (squash) January 28, 2024 12:20
@lunny lunny added this to the 1.22.0 milestone Jan 28, 2024
@lunny lunny merged commit d9b3849 into go-gitea:main Jan 28, 2024
25 checks passed
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Jan 28, 2024
@wackbyte wackbyte deleted the oauth2-enabled branch January 28, 2024 20:47
zjjhot added a commit to zjjhot/gitea that referenced this pull request Jan 29, 2024
* giteaofficial/main:
  [skip ci] Updated licenses and gitignores
  Fix bug for generated repository object format (go-gitea#28969)
  Fixing small space missing in sample config file (go-gitea#28967)
  Fix inconsistent naming of OAuth 2.0 `ENABLE` setting (go-gitea#28951)
  Add screenshot for "Profile Readmes" to docs (go-gitea#28964)
  Simplify how git repositories are opened (go-gitea#28937)
  Preserve BOM in web editor (go-gitea#28935)
  Make loading animation less aggressive (go-gitea#28955)
  Fix SSPI user creation (go-gitea#28948)
  Strip `/` from relative links (go-gitea#28932)
  Fix non-alphabetic sorting of repo topics (go-gitea#28938)
  Don't remove all mirror repository's releases when mirroring (go-gitea#28817)
  Use new RPM constants (go-gitea#28931)
  Check for sha256 support to use --object-format flag (go-gitea#28928)
  fix: update enable_prune even if mirror_interval is not provided (go-gitea#28905)
  Implement `MigrateRepository` for the actions notifier (go-gitea#28920)
  Respect branch info for relative links (go-gitea#28909)
henrygoodman pushed a commit to henrygoodman/gitea that referenced this pull request Jan 31, 2024
Renames it to `ENABLED` to be consistent with other settings and
deprecates it.

I believe this change is necessary because other setting groups such as
`attachment`, `cors`, `mailer`, etc. have an `ENABLED` setting, but
`oauth2` is the only one with an `ENABLE` setting, which could cause
confusion for users.

This is no longer a breaking change because `ENABLE` has been set as
deprecated and as an alias to `ENABLED`.
silverwind pushed a commit to silverwind/gitea that referenced this pull request Feb 20, 2024
Renames it to `ENABLED` to be consistent with other settings and
deprecates it.

I believe this change is necessary because other setting groups such as
`attachment`, `cors`, `mailer`, etc. have an `ENABLED` setting, but
`oauth2` is the only one with an `ENABLE` setting, which could cause
confusion for users.

This is no longer a breaking change because `ENABLE` has been set as
deprecated and as an alias to `ENABLED`.
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/docs size/M Denotes a PR that changes 30-99 lines, ignoring generated files. type/deprecation Previously provided functionality is removed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants