[test_operator] Automatic sync of README.md#3589
[test_operator] Automatic sync of README.md#3589sauragar wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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.
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/e6bd5c4155b14750817cdc542eae5cdb ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 25m 36s |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/f84c25fe639c4a2eaf5b977d149e5a2f ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 21m 51s |
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/5e37469eb30e4f58babd13c526c9336d ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 43m 11s |
sauragar
force-pushed
the
OSPRH-19423
branch
2 times, most recently
from
8ec6c0d to
17a9248
Compare
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/9f0e30fc2e7744ea9397e32491a751b8 ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 07m 46s |
sauragar
force-pushed
the
OSPRH-19423
branch
from
17a9248 to
7b9c343
Compare
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/72129788e2904a1483acf4f9149c5de7 ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 17m 16s |
sauragar
force-pushed
the
OSPRH-19423
branch
from
7b9c343 to
b1e97de
Compare
sauragar
force-pushed
the
OSPRH-19423
branch
from
559f8f9 to
3e046a1
Compare
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/9f4e78462c834b88bc530aebb8514cda ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 15m 02s |
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
Looks good from my side. I will wait for the pre-commit fix and approve. @michburk please check out the change to see if everything is okay from your side.
sauragar
force-pushed
the
OSPRH-19423
branch
from
3e046a1 to
6d3dcb9
Compare
kstrenkova
left a comment
kstrenkova
left a comment
There was a problem hiding this comment.
Pre-commit check passed, so lgtm from my side.
sauragar
force-pushed
the
OSPRH-19423
branch
from
6d3dcb9 to
ee5f24c
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
bd2064a to
49e2096
Compare
|
Build failed (check pipeline). Post https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/c5e35e90fffa43e89809da2b9e6ed9a0 ✔️ openstack-k8s-operators-content-provider SUCCESS in 2h 16m 31s |
3 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