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

Environment Variable Lifecycle #8258

Closed
3 tasks done
dragonchaser opened this issue Jan 22, 2024 · 2 comments
Closed
3 tasks done

Environment Variable Lifecycle #8258

dragonchaser opened this issue Jan 22, 2024 · 2 comments
Assignees

Comments

@dragonchaser
Copy link
Member

dragonchaser commented Jan 22, 2024

To automatically create a changelist for environment-variables between versions we need to introduce a new field to the variable description that contains the introduction version of the variable.

Currently those descriptions look like this:

Timeout int64         `yaml:"timeout" env:"ANTIVIRUS_ICAP_TIMEOUT" desc:"Timeout for the ICAP client." deprecationVersion:"5.0" removalVersion:"6.0" deprecationInfo:"Changing the envvar type for consistency reasons." deprecationReplacement:"ANTIVIRUS_ICAP_SCAN_TIMEOUT"`

In the future it should look like this:

Timeout int64         `yaml:"timeout" env:"ANTIVIRUS_ICAP_TIMEOUT" desc:"Timeout for the ICAP client." introductionVersion:"4.0" deprecationVersion:"5.0" removalVersion:"6.0" deprecationInfo:"Changing the envvar type for consistency reasons." deprecationReplacement:"ANTIVIRUS_ICAP_SCAN_TIMEOUT"`

TODO:

  • Prerequisite: Add the introductionVersion field to all existing environment variables #8434
  • Write an extension to the ci that rejects PRs that contain env variables without the introductionVersion field
    implementation of the step is in Check env var annotations #8436 not added to the ci yet
  • Create a tool in docs/helpers that creates a list of environment variables between to versions (those versions should be passed to the tool using cli arguments. For example envdeltahelper 4.0 5.0 should create the list of newly introduced variables between 4.0 and 5.0.
  • [ ] Include this tool into the release pipeline and append the corresponding list to the changelog upon release. Needs to be run manually for now
@dragonchaser
Copy link
Member Author

/cc @mmattel && @micbar

@dragonchaser
Copy link
Member Author

dragonchaser commented Feb 15, 2024

current approach is in #8454 blocked unti #8434 is solved

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant