Repository navigation
ci: add reusable installer XML change check - #109
Merged
crowecawcaw merged 1 commit intoOct 8, 2026
Merged
crowecawcaw merged 1 commit into
crowecawcaw merged 1 commit into
Conversation
karthikbekalp
force-pushed
the
ci/installer-xml-change-check
branch
2 times, most recently
from
October 7, 2026 22:56
6fd81a3 to
a179d33
Compare
Add a standalone reusable Python check that flags installer XML edits with an optional reminder to review corresponding shared installer updates. Document repository setup, expected failures, and author follow-up. Signed-off-by: Karthik BekalPattathana <133984042+karthikbekalp@users.noreply.github.com>
karthikbekalp
force-pushed
the
ci/installer-xml-change-check
branch
from
October 7, 2026 22:57
a179d33 to
7f97f86
Compare
karthikbekalp
marked this pull request as ready for review
October 7, 2026 22:59
This was referenced Oct 7, 2026
andychoquette
approved these changes
Oct 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was the problem/requirement? (What/Why)
Some individual submitter installer changes were missing from the shared installer. This check reminds authors to review whether the shared installer also needs an update.
What was the solution? (How)
Add
reusable_installer_xml_check.ymlwith a small Python check. It uses Git to compare the PR's changes.Adding, editing, deleting, or renaming an XML file under
installer/orinstall_builder/fails the check, including nested files and formatting-only edits. With no matching XML changes, it passes.The log lists the changed files and shows:
What is the impact of this change?
To enable the check:
.github/workflows/installer_xml_check.ymlto each submitter repository included in the shared installer, using the example in.github/installer-xml-changes.md.Each repository adds the workflow once. Future updates come from
@mainline. It runs on PRs, including drafts, separately from Security Scan and Code Quality.When it fails, review the listed files and check whether the shared installer needs an update. Arrange any follow-up and confirm in the PR discussion: "Follow-up is complete", "Follow-up is under review", or "No follow-up is needed". Keep private details and links out of public discussions.
This is an optional reminder. It stays failed after confirmation while the XML change is in the PR. It does not verify updates to the shared installer. The job has read-only access and does not run PR code or installer definitions.
Dependent draft PRs
Merge this PR first, then these eight submitter workflows:
How was this change tested?
git diff --checkpassed.Was this change documented?
Yes, in
.github/installer-xml-changes.md, with setup instructions and what to do when the check fails.Is this a breaking change?
No. Each repository chooses whether to add the workflow.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.