Skip to content

[test_operator] Add pre-commit hook to auto-sync test_operator README #3784

Open
sauragar wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
sauragar:OSPRH-27466
Open

[test_operator] Add pre-commit hook to auto-sync test_operator README #3784
sauragar wants to merge 1 commit intoopenstack-k8s-operators:mainfrom
sauragar:OSPRH-27466

Conversation

@sauragar
Copy link
Contributor

This automates the synchronization between roles/test_operator/defaults/main.yml and roles/test_operator/README.md. When defaults/main.yml is modified, the pre-commit hook automatically runs the sync script and updates the README.

The hook will:

  • Trigger on changes to roles/test_operator/defaults/main.yml
  • Run scripts/sync_test_operator_var_readme.py
  • Update roles/test_operator/README.md if needed
  • Block the commit and ask developer to stage README changes

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Mar 19, 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 tosky 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

This automates the synchronization between roles/test_operator/defaults/main.yml
and roles/test_operator/README.md. When defaults/main.yml is modified, the
pre-commit hook automatically runs the sync script and updates the README.

The hook will:
- Trigger on changes to roles/test_operator/defaults/main.yml
- Run scripts/sync_test_operator_var_readme.py
- Update roles/test_operator/README.md if needed
- Block the commit and ask developer to stage README changes

Signed-off-by: sauragar <sauragar@redhat.com>
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.

1 participant