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

[bugfix] Align default values in the configuration file with the code #1971

Merged
merged 4 commits into from
Jul 12, 2023

Conversation

firescry
Copy link
Contributor

@firescry firescry commented Jul 9, 2023

Description

If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements.

If this is a documentation change, please briefly describe what you've changed and why.

This pull request aligns default values defined in example/config.yaml and in internal/config/defaults.go - in most cases changes are done to the config file.
There is one exception where default value is added to defaults.go - it is for AdvancedThrottlingRetryAfter variable introduced as part of #1466.
Also snippets of config.yaml file are updated in the documentation.

Closes #1964

Checklist

Please put an x inside each checkbox to indicate that you've read and followed it: [ ] -> [x]

If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

@daenney
Copy link
Member

daenney commented Jul 10, 2023

I think this looks pretty good, and it's honestly something I'd be fine with merging in the RC-cycle as it fixes a bunch of erroneous values in example/config.yaml. We tell people to review and adopt those values when upgrading, so right now a bunch of instances are probably slightly misconfigured.

@tsmethurst what do you think?

@firescry firescry marked this pull request as ready for review July 10, 2023 19:13
@firescry
Copy link
Contributor Author

Thanks for the review! 😊

I set it as "ready for review" in case you would like to merge it as it is.

example/config.yaml Outdated Show resolved Hide resolved
@tsmethurst
Copy link
Contributor

This is helpful, thank you!

firescry added 4 commits July 11, 2023 22:14
This parameter should contain proper e-mail address (to be provided by user during configuration).
Default values and related comments in example/config.yaml are aligned
with values defined in internal/config/defaults.go.
Small improvements to foramting of config.yaml file.
@tsmethurst tsmethurst merged commit 8d92b24 into superseriousbusiness:main Jul 12, 2023
@tsmethurst
Copy link
Contributor

Kapow!

@firescry firescry deleted the defaults branch September 23, 2023 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[bug] Discrepancies in default values in config.yaml and in the code
3 participants