Skip to content

Introduce "config edit-ini" sub command to help maintaining INI config file #35735

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Oct 25, 2025
Merged

Introduce "config edit-ini" sub command to help maintaining INI config file #35735

merged 9 commits into from
Oct 25, 2025

Conversation

@wxiaoguang
Copy link
Contributor

@wxiaoguang wxiaoguang commented Oct 23, 2025 •
edited
Loading

Ref: #32669. Helps addressing https://gitea.com/gitea/helm-chart/issues/356.

  • Keep Specified Keys

If you need to re-create the configuration file with only a subset of keys,
you can provide an INI template file and use the "--config-keep-keys" flag.
For example, if a helm chart needs to reset the settings and only keep SECRET_KEY,
it can use a template file like:

  [security]
  SECRET_KEY=

$ ./gitea config edit-ini --config app-old.ini --config-keep-keys app-template.ini --out app-new.ini

@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Oct 23, 2025
@github-actions github-actions bot added modifies/go Pull requests that update Go code modifies/cli PR changes something on the CLI, i.e. gitea doctor or gitea admin modifies/internal labels Oct 23, 2025
@wxiaoguang wxiaoguang mentioned this pull request Oct 23, 2025
Closed
@wxiaoguang wxiaoguang added this to the 1.26.0 milestone Oct 23, 2025
@wxiaoguang wxiaoguang added the type/feature Completely new functionality. Can only be merged if feature freeze is not active. label Oct 23, 2025
lunny
lunny reviewed Oct 23, 2025
View reviewed changes
@lunny
Copy link
Member

lunny commented Oct 23, 2025

Maybe this is a good opportunity to restrict environment-based configuration to only specific sections.

TheFox0x7
TheFox0x7 reviewed Oct 23, 2025
View reviewed changes
@wxiaoguang wxiaoguang changed the title Intorduce "config update-ini" sub command to help maintain INI config file Intorduce "config update-ini" sub command to help maintaining INI config file Oct 24, 2025
wxiaoguang
wxiaoguang commented Oct 24, 2025
View reviewed changes
TheFox0x7
TheFox0x7 approved these changes Oct 24, 2025
View reviewed changes
Copy link
Contributor

@TheFox0x7 TheFox0x7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving as the only concern I have are flag name and semi-clear instructions, the latter of which can easily be reworded if someone will have questions about the behavior.
I don't have much better ideas for the flag name though the template part still feels wrong here but naming things always was hard :)

@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 Oct 24, 2025
@wxiaoguang
Copy link
Contributor Author

wxiaoguang commented Oct 24, 2025 •
edited
Loading

Applied your suggestions and made new changes:

  • use edit-ini instead of update-ini, "update" sounds like "change the existing thing", "edit" is like sed: edit and save
  • add --in-place flag (also like sed), then we don't need to worry about the input file would be accidentally overwritten.
  • use --config-keep-keys as you suggested.

@wxiaoguang wxiaoguang changed the title Intorduce "config update-ini" sub command to help maintaining INI config file Intorduce "config edit-ini" sub command to help maintaining INI config file Oct 24, 2025
@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 Oct 24, 2025
@lunny lunny added the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Oct 24, 2025
@wxiaoguang wxiaoguang merged commit cb72c90 into go-gitea:main Oct 25, 2025
26 checks passed
@wxiaoguang wxiaoguang deleted the fix-env-ini branch October 25, 2025 02:54
@GiteaBot GiteaBot removed the reviewed/wait-merge This pull request is part of the merge queue. It will be merged soon. label Oct 25, 2025
@wxiaoguang wxiaoguang changed the title Intorduce "config edit-ini" sub command to help maintaining INI config file Introduce "config edit-ini" sub command to help maintaining INI config file Oct 25, 2025
@silverwind
Copy link
Member

silverwind commented Oct 27, 2025 •
edited
Loading

Will the GITEA__ env vars work in non-docker environments as well with this? It's certainly something I'd like to have because we should not single out docker, env vars are universal.

@wxiaoguang
Copy link
Contributor Author

Will the GITEA__ env vars work in non-docker environments as well with this? It's certainly something I'd like to have because we should not single out docker, env vars are universal.

Yes

zjjhot added a commit to zjjhot/gitea that referenced this pull request Oct 30, 2025
@zjjhot
Merge remote-tracking branch 'giteaofficial/main'
064fce5 
* giteaofficial/main:
  [skip ci] Updated translations via Crowdin
  Revert go-gitea#18491, fix oauth2 client link account (go-gitea#35745)
  Upgrade go mail to 0.7.2 (go-gitea#35748)
  [skip ci] Updated translations via Crowdin
  Support actions and reusable workflows from private repos (go-gitea#32562)
  Use git model to detect whether branch exist instead of gitrepo method (go-gitea#35459)
  Fix shutdown waitgroup panic (go-gitea#35676)
  Intorduce "config edit-ini" sub command to help maintaining INI config file (go-gitea#35735)
  Improve online runner check (go-gitea#35722)
  Make "update file" API can create a new file when SHA is not set (go-gitea#35738)
  Fix review request webhook bug (go-gitea#35339) (go-gitea#35723)
  Misc tool tweaks (go-gitea#35734)
  Update dependencies (go-gitea#35733)
  Make external iframe render work (go-gitea#35730)
  Remove mermaid margin workaround (go-gitea#35732)

# Conflicts:
#	models/user/user.go
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lunny lunny lunny approved these changes

+1 more reviewer

@TheFox0x7 TheFox0x7 TheFox0x7 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. modifies/cli PR changes something on the CLI, i.e. gitea doctor or gitea admin modifies/go Pull requests that update Go code modifies/internal type/feature Completely new functionality. Can only be merged if feature freeze is not active.

Projects

None yet

Milestone

1.26.0

Development

Successfully merging this pull request may close these issues.

5 participants

@wxiaoguang @lunny @silverwind @TheFox0x7 @GiteaBot