[test_operator] Automatic sync of README.md#3589
[test_operator] Automatic sync of README.md#3589openshift-merge-bot[bot] merged 1 commit intoopenstack-k8s-operators:mainfrom
Conversation
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
Thank you for the PR! I have tested it locally and found a small issue with updating the defaults. It is explained in the comments, the fix should be rather simple. Other than that I saw the README sync was working nicely, so I think you're close to the finish 🎉 I like that the parameters will be in alphabetical order now :D Maybe there could be a mention of the script somewhere in the README so that people know they can use the sync when creating new variables or updating the old ones.
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/4de28a813ea54e73883c28ab7ff35c81 ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 18m 29s |
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
I am adding 2 comments about the same issue atop of my previous comments.
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/fe0fdd8386324989bd8ea335a95f52d6 ❌ openstack-k8s-operators-content-provider FAILURE in 4m 53s |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/5eac463796534f4b89b1f990b236fe22 ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 29m 11s |
sauragar
force-pushed
the
OSPRH-19423
branch
5 times, most recently
from
f256f7e to
c6e4dd2
Compare
sauragar
force-pushed
the
OSPRH-19423
branch
2 times, most recently
from
082fce7 to
f2cf98b
Compare
sauragar
force-pushed
the
OSPRH-19423
branch
2 times, most recently
from
3f17c9c to
5053771
Compare
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
I am leaving a few very small comments. I think the PR is almost done, so it would be a good idea to ask someone else for a review to get more perspective. I am also not sure about editing the pre-commit and setup_molecule files, we need someone from ci-framework for that :D
michburk
left a comment
michburk
left a comment
There was a problem hiding this comment.
A handful of comments and suggestions.
Overall, I understand the motivation to keep the readme up to date by using a script. We've done a pretty poor job of enforcing that the docs be updated with every change to the defaults, but I don't love the idea of designing and maintaining a script specifically for just one role's readme. I'd be curious to see what other cifmw folks have to say.
|
recheck |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/3bc1c9a16aeb42628016f8cf3fdaeeee ✔️ openstack-k8s-operators-content-provider SUCCESS in 29m 06s |
|
recheck |
sauragar
force-pushed
the
OSPRH-19423
branch
from
49e2096 to
54c1d89
Compare
Add automatic sync script to keep README.md in sync with defaults/main.yml: - Create sync_test_operator_var_readme.py for automated documentation updates - Generate GitHub URLs with line anchors for direct navigation to variable definitions - Display inline default values for simple/single-line variables - Redirect complex values (lists, dicts, multiline) to defaults/main.yml - Preserve existing default text variations (e.g., "Defaults to", "defaults to") - Only add "Default value:" when completely missing from documentation - Reorganize parameter documentation in alphabetical order - Add auto-sync note at the top of README.md - Fix pre-commit ansible-lint compatibility Signed-off-by: Saurabh Agarwal <sauragar@redhat.com> Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
sauragar
force-pushed
the
OSPRH-19423
branch
from
54c1d89 to
91925d6
Compare
|
recheck |
1 similar comment
|
recheck |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/6cd4199a72af4cccbab5d63534c85598 ✔️ openstack-k8s-operators-content-provider SUCCESS in 27m 49s |
|
recheck |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/de2d99a5256744f28746b92c94bd6802 ✔️ openstack-k8s-operators-content-provider SUCCESS in 28m 07s |
|
recheck |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/234171f9308c4152b21287d43029ea62 ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 12m 48s |
|
recheck |
|
@michburk Can you please approve this so that we can merge this change? |
michburk
left a comment
michburk
left a comment
There was a problem hiding this comment.
A couple little things, maybe put them down as ideas for future improvements.
|
/lgtm |
|
/approve |
|
@rebtoor Can you please take a look, we don't have the approve rights here it seems :D |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: kstrenkova, michburk The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit b737ebc
into
openstack-k8s-operators:main
5 participants
This commit will ensure to have the proper auto-sync of README.md with the defaults/main.yml file and also added the post-commit file so whenever someone commits in the defaults/main.yml file the script can be auto-run
Ticket: OSPRH-19423
This PR #3327 is closed since I am not able to reopen the PR
Signed-off-by: Saurabh Agarwal sauragar@redhat.com