Skip to content

chore(ci): warn when a change touches downstream-mirrored files - #8765

Open
kevinpschaaf wants to merge 2 commits into
opal-eolfrom
downstream-mirror-check
Open

kevinpschaaf wants to merge 2 commits into
opal-eolfrom
downstream-mirror-check

Conversation

@kevinpschaaf

Copy link
Copy Markdown
Collaborator

A small subset of this repo is mirrored to an internal repo.

Adds a check with two entry points sharing one detection script:

  • A pre-push hook that prints a loud banner listing the affected files. Never blocks; it is there so the need for a sync is known before the PR is even opened.
  • A GitHub workflow that annotates each changed mirrored file and fails until the PR description contains the literal token ACK_SYNC_REQUIRED.

The list of mirrored files lives in .github/mirrored-files.txt, whose header also carries the sync procedure and the constraints that apply to mirrored code (limited imports, the private-field rewrite, and so on).

Also available locally as npm run check:mirror.

A small subset of this repo is mirrored into a downstream internal
repository. Changing one of those files requires a sync, and today there
is nothing that says so — the drift is only noticed later, downstream.

Adds a check with two entry points sharing one detection script:

- A pre-push hook that prints a loud banner listing the affected files.
  Never blocks; it is there so the need for a sync is known before the
  PR is even opened.
- A GitHub workflow that annotates each changed mirrored file and fails
  until the PR description contains the literal token
  ACK_SYNC_REQUIRED. A warning gets scrolled past, a red X does not, and
  the token makes these PRs greppable later.

The list of mirrored files lives in .github/mirrored-files.txt, whose
header also carries the sync procedure and the constraints that apply to
mirrored code (limited imports, the private-field rewrite, and so on).

Also available locally as `npm run check:mirror`.

@mrsalexander707-crypto mrsalexander707-crypto left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

👍

Signed-off-by: Kevin Schaaf <kschaaf@google.com>

This branch has not been deployed

No deployments
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.

2 participants