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

Merge latest main before running Percy #5300

Merged
merged 5 commits into from
Aug 14, 2024

Conversation

jmuzina
Copy link
Member

@jmuzina jmuzina commented Aug 13, 2024

Done

  • Modifies the Percy "prepare" workflow to check out a merge commit of main and a PR, rather than the PR head commit.
    • Reduces the need for us to rebase/merge main into each PR before running Percy.
    • Manual rebasing/merging will still need to happen if conflicts are present between the PR and main - Percy will not be triggered if merge conflicts are detected, since GH doesn't run workflows on PRs with merge conflicts.
  • Removes the repository parameter from the Percy prepare job as it is no longer needed.
  • Adds some more helpful input parameter documentation for the Percy prepare job.

Context:

Merging main into the checked out commit is default behavior for actions/checkout, but it is documented poorly (see issue). Our current code is forcing actions/checkout to check out the head of the PR (ignoring main) - so all we need to do in order to merge main into the checked out code is get rid of repository and ref inputs to actions/checkout.

Fixes #5282, WD-13965

QA

  • Review test PR
    • Download the percy artifact uploaded by the prepare job
    • Open scss/_vanilla.scss and verify line 4 reads // This was added by the PR Test.
    • Verify that this modification to _vanilla.scss is not in the main branch of my fork, and was added by the test PR.
    • Open scss/_base.scss and verify line 2 reads // This was added by the main branch.
    • Verify that this modification to _base.scss is only in the main branch of my fork, and is not present in my PR's source.

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 release (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.

@jmuzina jmuzina added Review: QA needed Review: Code needed Maintenance 🔨 Review: Percy needed This PR needs a review of Percy for visual regressions labels Aug 13, 2024
@webteam-app
Copy link

@jmuzina jmuzina changed the title Merge before running Percy Merge latest main before running Percy Aug 13, 2024
@jmuzina jmuzina force-pushed the 5282-merge-percy-test branch from 2ec3fa0 to 9b7173c Compare August 13, 2024 21:19
@jmuzina jmuzina force-pushed the 5282-merge-percy-test branch from 9b7173c to be6a411 Compare August 13, 2024 21:24
@jmuzina jmuzina force-pushed the 5282-merge-percy-test branch from 28f25f9 to 2222598 Compare August 13, 2024 21:26
@jmuzina jmuzina marked this pull request as ready for review August 13, 2024 21:33
@jmuzina jmuzina requested a review from pastelcyborg August 13, 2024 21:33
@jmuzina jmuzina removed the Review: Percy needed This PR needs a review of Percy for visual regressions label Aug 14, 2024
@jmuzina jmuzina merged commit 0a6ac97 into canonical:main Aug 14, 2024
9 checks passed
@jmuzina jmuzina deleted the 5282-merge-percy-test branch August 14, 2024 14:20
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.

Merge/Rebase Percy Artifacts
3 participants