Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Percy GHA Migration - PR Status check reflects Percy diff state #5092

Closed

Conversation

jmuzina
Copy link
Member

@jmuzina jmuzina commented May 16, 2024

Done

Extension of #5089 that makes the Percy PR status check a bit smarter; now the status check will actually reflect the diff state of the Percy build. If a PR has Percy diffs, it will fail, and it will pass if it has no diffs.

In the case that a PR has diffs that are then approved, you should re-run the snapshots job to update the status check to passed.

Do not review or merge until merging of #5089

Closes WD-11262

QA

  • View example PR with Percy diffs
  • Verify that the snapshots job fails due to diffs detected
  • Follow the Percy build link in the snapshots job above & verify that there are unexpected diffs present.
  • Verify that the status check associated with the failing build reports unexpected diffs.
  • Verify that the snapshots job run after fixing the above diffs passes with no diffs from baseline
  • Verify that the Percy build link associated with the passing snapshot reports no diffs
  • Verify that the status check associated with the passing build reports no diffs.

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
    • if CSS class names are not changed it can be bugfix relesase (x.x.X)
    • if CSS class names are changed/added/removed it should be minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.

Screenshots

image

@jmuzina jmuzina self-assigned this May 16, 2024
@webteam-app
Copy link

@jmuzina
Copy link
Member Author

jmuzina commented May 16, 2024

Here's a PR in a fork context that demonstrates the above QA: canonical/test-web-percy-gha-migration#13

jmuzina added a commit to jmuzina/vanilla-framework that referenced this pull request May 17, 2024
bartaz pushed a commit that referenced this pull request May 21, 2024
@bartaz
Copy link
Contributor

bartaz commented May 28, 2024

We want to try to enable official integration first, instead.

@jmuzina
Copy link
Member Author

jmuzina commented Jun 5, 2024

Closing this as it will be handled instead by the GHA-Percy integration being worked on by @bartaz

@jmuzina jmuzina closed this Jun 5, 2024
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.

None yet

3 participants