Skip to content

ci: add reusable installer XML change check - #109

Merged
crowecawcaw merged 1 commit into
aws-deadline:mainlinefrom
karthikbekalp:ci/installer-xml-change-check
Oct 8, 2026
Merged

crowecawcaw merged 1 commit into
aws-deadline:mainlinefrom
karthikbekalp:ci/installer-xml-change-check

Conversation

@karthikbekalp

@karthikbekalp karthikbekalp commented Oct 7, 2026 •

Copy link
Copy Markdown

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.yml with a small Python check. It uses Git to compare the PR's changes.

Adding, editing, deleting, or renaming an XML file under installer/ or install_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:

Installer definitions changed. Please verify whether any related internal changes are needed to reflect the changes in this PR.

What is the impact of this change?

To enable the check:

  1. Merge this PR.
  2. Add .github/workflows/installer_xml_check.yml to 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?

  • All 58 existing repository tests passed.
  • The Python check passed 17 Git-based scenarios covering edits, renames, unrelated files, target-branch changes, Git errors, and safe filename reporting.
  • Cinema 4D test PR #584 used the same Python check and added one XML comment. The GitHub Actions run ran on the draft PR, found the changed XML file, and failed as expected with the reminder and exit code 1. The test PR is closed without merging.
  • The workflow and documented caller passed actionlint and zizmor validation.
  • git diff --check passed.

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.

@karthikbekalp karthikbekalp changed the title ci: flag installer XML edits in shared PR scans ci: add reusable installer XML change check Oct 7, 2026
@karthikbekalp
karthikbekalp force-pushed the ci/installer-xml-change-check branch 2 times, most recently from 6fd81a3 to a179d33 Compare October 7, 2026 22:56
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>
@crowecawcaw
crowecawcaw merged commit e6fc976 into aws-deadline:mainline Oct 8, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants