[test_operator] Automatic sync of README.md #3589
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
- Add automatic sync script (sync_test_operator_var_readme.py) to keep README.md in sync with defaults/main.yml - Reorganize parameter documentation in alphabetical order - Replace inline default value definitions with references to defaults/main.yml to reduce duplication and improve maintainability - 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>
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
|
|
||
| # 1️⃣ Redirect if value is complex | ||
| if should_redirect(value): | ||
| print("should_redirect =", should_redirect(value)) |
There was a problem hiding this comment.
When you run the script there are a lot of these prints, which say nothing to the user. I think it could be removed.
| # Convert Python bool to lowercase for consistency | ||
| if isinstance(value, bool): | ||
| value_str = str(value).lower() | ||
| elif value is None: |
There was a problem hiding this comment.
I don't think the if or elif is needed. It should reflect the real values that are in the defaults/main.yaml file. I am not sure why the value can be None when in the defaults/main.yaml there are no None, so you can correct me.
|
|
||
| def normalize_default_text(block, value): | ||
| # Normalize "Defaults to `x`" → "Default value: `x`" | ||
| block = re.sub( |
There was a problem hiding this comment.
I don't think this substitution is needed. If someone wanted to, they could also do Default: and this code wouldn't help to keep consistency. So I don't think it's necessary to normalize it, as you can never catch all cases.
2 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
Signing off: Saurabh Agarwal sauragar@redhat.com