infinispan / infinispan-operator

Infinispan Operator
https://infinispan.org/docs/infinispan-operator/main/operator.html
Apache License 2.0
48 stars 54 forks source link

Automate adding new operands and generating documentation #2156

Closed ryanemerson closed 13 hours ago

ryanemerson commented 1 day ago

The Operands defined by the env var INFINISPAN_OPERAND_VERSIONS in config/manager/manager.yaml is now the canonical source of truth for Operands supported in the tag/branch. The testsuite uses a modified version of this array in commons.go, with the required downstream-version, Deprecated and CVE fields added as required by the testsuite. Similarly, all references to Operand versions in the documentation are now generated based upon the current Operator version (defined in ./version.txt) and Operands specified in INFINISPAN_OPERAND_VERSIONS.

@Crumby As the testsuite still loads INFINISPAN_OPERAND_VERSIONS from the environment variables if explicitly defined, I don't think this should have any impact on the downstream tests.

Here are various runs on my fork: https://github.com/ryanemerson/infinispan-operator/actions/workflows/add_operand.yml

You can see on main commits containing different operand versions that were added via the action.

ryanemerson commented 1 day ago

not a priority but it would be also great to have an "automatically generated" notice to all the generated files

Great idea! I've added a comment to the generated files with pointers to how/where they're generated.

rigazilla commented 13 hours ago

thanks @ryanemerson !