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

Annotations in services code for envvars seem to be broken #10388

Open
mmattel opened this issue Oct 23, 2024 · 1 comment
Open

Annotations in services code for envvars seem to be broken #10388

mmattel opened this issue Oct 23, 2024 · 1 comment
Labels

Comments

@mmattel
Copy link
Contributor

mmattel commented Oct 23, 2024

When running grep -rn deprecationVersion + make -C docs docs-generate, the resulting env_vars.yaml does not contain deprecation version for the following:

clientlog/pkg/config/config.go:23:	RevaGateway string `yaml:"reva_gateway" env:"OCIS_REVA_GATEWAY;CLIENTLOG_REVA_GATEWAY" desc:"CS3 gateway used to look up user metadata" introductionVersion:"5.0" deprecationVersion:"6.0" removalVersion:"%%NEXT_PRODUCTION_VERSION%%" deprecationInfo:"CLIENTLOG_REVA_GATEWAY removed for simplicity."`
[...]
collaboration/pkg/config/cs3api.go:14:	Name string `yaml:"name" env:"OCIS_REVA_GATEWAY;COLLABORATION_CS3API_GATEWAY_NAME" desc:"CS3 gateway used to look up user metadata." introductionVersion:"6.0.0" deprecationVersion:"6.0" removalVersion:"%%NEXT_PRODUCTION_VERSION%%" deprecationInfo:"COLLABORATION_CS3API_GATEWAY_NAME removed for simplicity."`
@dragonchaser
Copy link
Member

dragonchaser commented Oct 23, 2024

Relevant code:

if semver.IsValid(field.DeprecationVersion) && semver.Compare(startVersion, field.DeprecationVersion) <= 0 && semver.Compare(endVersion, field.DeprecationVersion) > 0 {
variableList["deprecated"] = append(variableList["deprecated"], field)
}

Either this code is buggy or the annotation in the lines mentioned by @mmattel are somehow malformed...

@mmattel mmattel changed the title Annotations in services code is for envvars seems to be broken Annotations in services code for envvars seems to be broken Oct 23, 2024
@dragonchaser dragonchaser changed the title Annotations in services code for envvars seems to be broken Annotations in services code for envvars seem to be broken Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Prio 3 or less
Development

No branches or pull requests

2 participants