Skip to content

[test_operator] Fix sync README script#3855

Open
kstrenkova wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
kstrenkova:fix-sync-readme-script
Open

[test_operator] Fix sync README script#3855
kstrenkova wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
kstrenkova:fix-sync-readme-script

Conversation

@kstrenkova
Copy link
Copy Markdown
Contributor

Empty lists/dicts now display inline (e.g., []) instead of redirecting to defaults file. Removed line number tracking and anchors - links now point to main.yml file without #L123 fragments for simpler navigation. This change was also done, so that when adding a new parameter, users don't have to run the sync script first to apply changes to the line numbers.

@openshift-ci
Copy link
Copy Markdown
Contributor

openshift-ci bot commented Apr 15, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign yorabl for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kstrenkova kstrenkova requested a review from michburk April 15, 2026 09:15
@kstrenkova kstrenkova force-pushed the fix-sync-readme-script branch from 584701b to 78b3cf4 Compare April 15, 2026 09:16
@kstrenkova kstrenkova changed the title [test-operator] Fix sync README script [test_operator] Fix sync README script Apr 15, 2026
@kstrenkova
Copy link
Copy Markdown
Contributor Author

Hello @michburk 👋 I have created a change that removes the line numbers from the link and hopefully also removes all the dead code created by such change. Additionally, with my new parameter I noticed that even if the default is an empty array [], the script would put a link there instead. So I fixed that as well, as you can see in the new README that was generated by running the script.

@michburk
Copy link
Copy Markdown
Contributor

michburk commented Apr 15, 2026

Looks good @kstrenkova thank you! Before we merge this, do you think we should merge #3698, then rebase this on top + re-run the updated sync script in this pr? 3689 has been open for a good while and I don't want to delay it further with another snag because of more readme sync changes 😅

Empty lists/dicts now display inline (e.g., []) instead of
redirecting to defaults file. Removed line number tracking and
anchors - links now point to main.yml file without #L123 fragments
for simpler navigation. This change was also done, so that when
adding a new parameter, users don't have to run the sync script
first to apply changes to the line numbers.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Katarina Strenkova <kstrenko@redhat.com>
@kstrenkova
Copy link
Copy Markdown
Contributor Author

@michburk I approved the other MR in the morning, rebased this one atop it and I think this one is now ready to get merged :D

Copy link
Copy Markdown
Contributor

@michburk michburk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants