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 Error Logging Improvement #5202

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

jmuzina
Copy link
Member

@jmuzina jmuzina commented Jul 1, 2024

Done

Improves error logging of the Percy snapshots action

Fixes MM thread

As a drive-by, fixes snapshots being taken of the examples index page. This removes 8 snapshots from the Percy tests:

  • docs/examples/index (in all themes, in mobile & desktop breakpoints) (4 snapshots)
  • docs/examples/standalone (in all themes, in mobile & desktop breakpoints) (4 snapshots)

QA

  • Review failing Percy workflow; verify you can see the Percy command output
  • Review passing Percy workflow; verify you can see the Percy command output, and the link to the created build is correct.
  • Checkout this repo and run the following command:
node -p "const fs=require('fs'),snapshots=require('./snapshots');(async()=>{try{const urls=await snapshots(),numSnapshots=urls.reduce((acc,url)=>acc+url.widths.length,0),data=JSON.stringify({numSnapshots,urls},null,4);fs.writeFileSync('percy_urls_report.json',data);console.log(`Exported ${numSnapshots} snapshots to percy_urls_report.json`)}catch(err){console.error('Error exporting snapshots:',err)}})()"
  • Open percy_urls_report.json and verify that no matches are found for any of the following:
    • /docs/examples/standalone/"
    • /docs/examples/index/

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.

@webteam-app
Copy link

@jmuzina jmuzina force-pushed the percy-error-output-improvement branch from 6fa957a to 5e0e747 Compare July 1, 2024 15:40
@jmuzina jmuzina marked this pull request as ready for review July 1, 2024 15:46
@jmuzina jmuzina merged commit affa6ca into canonical:main Jul 2, 2024
9 checks passed
@jmuzina jmuzina deleted the percy-error-output-improvement branch July 2, 2024 13:05
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.

4 participants