chore: adjust env vars so that check-env-var-annotations passes

[phil-davis]

Description

1. chore: adjust documentation of check-env-var-annotations.
2. display line numbers in the output of check-env-var-annotatrions. This makes it easy to find the exact line that has the problem.
3. adjust logic for annotation checks so that it really passes when there are no problems.
4. add introductionVersion "pre5.0" to all environment variable documentation.
5. add missing descriptions to environment variable documentation.
6. adjust some env var descriptions
7. add check-env-var-annotations to drone CI

This sets introductionVersion to "pre5.0" everywhere as a start. I suggest that we merge this, so that introductionVersion is defined everywhere, then I can separately work on removing "pre" for those env vars that are introduced in 5.0

This supersedes PR #8469

Related Issue

Part of #8434

How Has This Been Tested?

https://drone.owncloud.com/owncloud/ocis/32623/1/6

+ make check-env-var-annotations
.make/check-env-var-annotations.sh
All introductionVersion annotations are valid
All description annotations are valid

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Technical debt
• Tests only (no source changes)

Checklist:

• Code changes
• Unit tests added
• Acceptance tests added
• Documentation ticket raised:

[mmattel]

From what I have read, this all looks ok to me 👍

Following issue found: There are envvars that have been added in 5.0 and are therefore not pre5.0
The list added in 5.0 can be found at https://owncloud.dev/services/general-info/env-var-deltas/4.0.0-5.0.0-added/

[mmattel]

Needs (imho) backport to stable-5.0

found inconsistencies

[phil-davis]

From what I have read, this all looks ok to me 👍

Following issue found: There are envvars that have been added in 5.0 and are therefore not pre5.0 The list added in 5.0 can be found at https://owncloud.dev/services/general-info/env-var-deltas/4.0.0-5.0.0-added/

I am aware of that. My suggestion is that we can first merge this to get introductionVersion set everywhere.

The exact env vars that are introduced in 5.0 is a bit complex, due to the lines that have multiple env vars. So that is taking more time to sort out.

[phil-davis]

Note: these env vars are actually in tracing.go so I have adjusted the md file.
FYI @mmattel @dragonchaser
If I find other minor things in the md file, I will push those also.

[phil-davis]

Things I found:
MICRO_REGISTRY in ocis-pkg/registry/registry.go
MICRO_REGISTRY_AUTH_USERNAME in ocis-pkg/natsjsregistry/registry.go
MICRO_REGISTRY_AUTH_PASSWORD in ocis-pkg/natsjsregistry/registry.go
These are not in a format that will allow specifying introduction version.

OCIS_CACHE_DISABLE_PERSISTENCE;GATEWAY_STAT_CACHE_DISABLE_PERSISTENCE not found
OCIS_CACHE_DISABLE_PERSISTENCE;STORAGE_USERS_STAT_CACHE_DISABLE_PERSISTENCE not found
These are in the 4.0.0-5.0.0-added.md file but I can't find them in the code.

[phil-davis]

I think that these are the correct names - they exist in services/settings/pkg/config/config.go

[phil-davis]

@mmattel @dragonchaser all done - please look and comment about anything that I have missed or needs changing.

[phil-davis]

Needs (imho) backport to stable-5.0

I will do that when this Pr to master is reviewed

[mmattel]

I will do that when this Pr to master is reviewed

👍 Pls add the following related and merged PR to backporting
#8577 ([docs-only] Fix added envars table) and
#8582 ([docs-only] And more envvars that are added to the table)

[mmattel]

@phil-davis There was a conflict because #8523 got merged which I solved. That PR contained new envvars relevant for master and later 5.1 BUT...

When doing a backport to stable-5.0 you need to change back in services/web/pkg/config/config.go:

	DeprecatedPath string `yaml:"path" env:"WEB_ASSET_PATH" desc:"Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets." deprecationVersion:"5.1.0" removalVersion:"6.0.0" deprecationInfo:"The WEB_ASSET_PATH is deprecated and will be removed in the future." deprecationReplacement:"Use WEB_ASSET_CORE_PATH instead." introductionVersion:"pre5.0"`
	CorePath       string `yaml:"core_path" env:"WEB_ASSET_CORE_PATH" desc:"Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets." introductionVersion:"5.1"`
	AppsPath       string `yaml:"apps_path" env:"WEB_ASSET_APPS_PATH" desc:"Serve ownCloud Web apps assets from a path on the filesystem instead of the builtin assets." introductionVersion:"5.1"`

to

	Path string `yaml:"path" env:"WEB_ASSET_PATH" desc:"Serve ownCloud Web assets from a path on the filesystem instead of the builtin assets." introductionVersion:"pre5.0"`

Else we get non 5.0 related content into the 5.0 branch.

[dragonchaser]

@phil-davis Please merge & backport to stable-5.0
Plus see the backporting comments from @mmattel above.

[phil-davis]

Rebased - CI should pass now, and we can merge.

[mmattel]

Looks good from a docs pov 👍

[sonarcloud]

Quality Gate failed

Failed conditions
43 New Bugs (required ≤ 0)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[phil-davis]

Now SonarCloud does not like the order of items in the yaml in ocis-pkg/shared/shared_types.go
It wants to re-order lines like:

	Level  string `yaml:"level" env:"OCIS_LOG_LEVEL" desc:"The log level. Valid values are: 'panic', 'fatal', 'error', 'warn', 'info', 'debug', 'trace'." introductionVersion:"pre5.0"`

to have the items in alphabetical order.

It complains about 43 lines in that one file, but does not complain about the same format in all the services/x/pkg/config/config.go files.

[phil-davis]

Note: backported to stable-5.0 in PR #8583