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

feat(self-hosted): convert experimental env vars to config options #29154

Merged

Conversation

RahulGautamSingh
Copy link
Collaborator

@RahulGautamSingh RahulGautamSingh commented May 19, 2024

Changes

  • Converted the following experimental env vars to self-hosted config options
Env var Config option
RENOVATE_X_DELETE_CONFIG_FILE deleteConfigFile
RENOVATE_X_S3_ENDPOINT s3Endpoint
RENOVATE_X_S3_PATH_STYLE s3PathStyle

There are some boolean types here. They could not be converted to experimentalFlags because GlobalConfig hasn't been initialized yet, when they are used, hence converting them to self-hosted config options instead.

Context

Last of: #27879 (comment)

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository (locally)

@RahulGautamSingh RahulGautamSingh requested review from HonkingGoose, rarkins and viceice and removed request for HonkingGoose and rarkins May 19, 2024 10:40
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
lib/config/options/index.ts Outdated Show resolved Hide resolved
lib/config/options/index.ts Outdated Show resolved Hide resolved
lib/config/options/index.ts Outdated Show resolved Hide resolved
lib/config/options/index.ts Outdated Show resolved Hide resolved
lib/config/options/index.ts Outdated Show resolved Hide resolved
lib/workers/global/config/parse/file.ts Outdated Show resolved Hide resolved
@RahulGautamSingh
Copy link
Collaborator Author

Verified each migration locally, by either logging the values of each option at runtime or confirming that they are working as expected
check 1: default values passed to functions ☑️
check 2: custom values (from cli, env, file), overwrites default values ☑️
check 3: old env vars parsed and then overwrite the default values ☑️

lib/config/options/index.ts Outdated Show resolved Hide resolved
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Some small things, then good to go.

docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
lib/util/s3.spec.ts Outdated Show resolved Hide resolved
lib/util/s3.ts Outdated Show resolved Hide resolved
lib/workers/global/config/parse/index.ts Outdated Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Copy link
Collaborator

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

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

Good to go for me. But the maintainers should do the final review. 😉

@RahulGautamSingh
Copy link
Collaborator Author

RahulGautamSingh commented Jul 24, 2024

It's been a while since I have tested these, so I will test once and open afterwards.

Updated: Test complete 🙌

@RahulGautamSingh RahulGautamSingh marked this pull request as draft July 24, 2024 22:18
@RahulGautamSingh RahulGautamSingh marked this pull request as ready for review July 25, 2024 12:10
Copy link
Collaborator

@rarkins rarkins left a comment

Choose a reason for hiding this comment

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

Needs conflict resolution

lib/instrumentation/reporting.ts Show resolved Hide resolved
lib/util/s3.ts Outdated Show resolved Hide resolved
lib/config/types.ts Outdated Show resolved Hide resolved
docs/usage/self-hosted-configuration.md Outdated Show resolved Hide resolved
lib/workers/global/config/parse/index.ts Outdated Show resolved Hide resolved
@rarkins
Copy link
Collaborator

rarkins commented Aug 6, 2024

@nabeelsaabna please review

Copy link
Contributor

@nabeelsaabna nabeelsaabna left a comment

Choose a reason for hiding this comment

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

We are only using RENOVATE_X_DELETE_CONFIG_FILE

@rarkins rarkins added this pull request to the merge queue Aug 7, 2024
Merged via the queue into renovatebot:main with commit 3857332 Aug 7, 2024
38 checks passed
@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 38.21.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants