Automate adding new operands and generating documentation #2156
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ryanemerson
force-pushed
the
automate_add_operand
branch
from
93db49c
to
0da7c62
Compare
rigazilla
reviewed
Sep 30, 2024
There was a problem hiding this comment.
great work @ryanemerson !
I added some comments,
not a priority but it would be also great to have an "automatically generated" notice to all the generated files
| @@ -0,0 +1 @@ | |||
| 2.4.5 | |||
There was a problem hiding this comment.
add some info about this new file in the doc (maybe readme)?
There was a problem hiding this comment.
Done. I plan to use the contents of this file more in the future, for example this will be used in scripts/ci/install-catalog-source.sh to initiate the VERSION field.
ryanemerson
force-pushed
the
automate_add_operand
branch
from
0da7c62
to
92f8647
Compare
ryanemerson
force-pushed
the
automate_add_operand
branch
from
92f8647
to
f9b1ea6
Compare
Great idea! I've added a comment to the generated files with pointers to how/where they're generated. |
rigazilla
reviewed
Oct 1, 2024
Co-authored-by: Vittorio Rigamonti <rigazilla@users.noreply.github.com>
|
thanks @ryanemerson ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Operands defined by the env var
INFINISPAN_OPERAND_VERSIONSinconfig/manager/manager.yamlis 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 inINFINISPAN_OPERAND_VERSIONS.@Crumby As the testsuite still loads
INFINISPAN_OPERAND_VERSIONSfrom 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
maincommits containing different operand versions that were added via the action.