ci(screener): disable screener PR checks #5253
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eriklharper
approved these changes
Sep 1, 2022
benelan
added a commit
that referenced
this pull request
Sep 7, 2022
**Related Issue:** #5253 ## Summary This PR cleanups up and combines stories to lower our snapshot count below 40k per month. - Append `_NoTest` to story names that we don't want screener to snapshot. - Append `_TestOnly` to story names that we do not want to appear in the [Storybook deployment on github pages](https://esri.github.io/calcite-components/?path=/story/overview-home--page). - Set up filters to accomplish the above two points. The filter determines which stories to skip using a boolean environment variable: `STORYBOOK_SCREENSHOT_TEST_BUILD`. The default is `NoTest`, and the env var is set to `true` in the [`pr-screener` workflow](https://github.com/Esri/calcite-components/blob/master/.github/workflows/pr-screener.yml). - Combine stories, e.g. if a component has "DarkTheme" and "RTL" snapshots, we combined them into a single `darkThemeRTL_TestOnly` snapshot. - Consistency cleanups, including camel case story names and using "simple" as the name for the first story (rather than "basic"). <!-- Please make sure the PR title and/or commit message adheres to the https://www.conventionalcommits.org/en/v1.0.0/ specification. Note: If your PR only has one commit and it is NOT semantic, you will need to either a. add another commit and wait for the check to update b. proceed to squash merge, but make sure the commit message is the same as the title. This is because of the way GitHub handles single-commit squash merges (see zeke/semantic-pull-requests#17) If this is component-related, please verify that: - [ ] feature or fix has a corresponding test - [ ] changes have been tested with demo page in Edge --- If this is skipping an unstable test: - include info about the test failure - submit an unstable-test issue by [choosing](https://github.com/Esri/calcite-components/issues/new/choose) the unstable test template and filling it out --> Co-authored-by: JC Franco <jfranco@esri.com> Co-authored-by: Erik Harper <eharperdicianno@esri.com>
benelan
added a commit
that referenced
this pull request
Sep 8, 2022
**Related Issue:** #5253 ## Summary This PR refines the PR linked above. Here are the conditions for when Screener runs on a PR: - Screener will run when when the `pr ready for visual snapshots` label is added to a normal PR (not draft PRs) - Screener will run when a draft PR with the `pr ready for visual snapshots` label is marked as "Ready to review" When someone pushes changes to a PR that has the `pr ready for visual snapshots label` (meaning snapshots already ran), __Screener will NOT run but it WILL show a green checkmark__ allowing the author to merge the PR. This is so that PRs can be merged w/o another Screener run if there are some small cleanups needed. If you need to rerun screener, remove and re-add the `pr ready for visual snapshots` label. Screener will still run on every push to `master`. This should provide a back up in case a visual regression slips through due to the point above. I will monitor the Screener runs on `master` while these limitations are in place. <!-- Please make sure the PR title and/or commit message adheres to the https://www.conventionalcommits.org/en/v1.0.0/ specification. Note: If your PR only has one commit and it is NOT semantic, you will need to either a. add another commit and wait for the check to update b. proceed to squash merge, but make sure the commit message is the same as the title. This is because of the way GitHub handles single-commit squash merges (see zeke/semantic-pull-requests#17) If this is component-related, please verify that: - [ ] feature or fix has a corresponding test - [ ] changes have been tested with demo page in Edge --- If this is skipping an unstable test: - include info about the test failure - submit an unstable-test issue by [choosing](https://github.com/Esri/calcite-components/issues/new/choose) the unstable test template and filling it out -->
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue: NA
Summary
Unfortunately we need to temporarily disable screener to prevent insane overage fees. We are working on a short term solution to turn screener back on, and a mid-term solution to switch to Chromatic. Screener can still be run on a branch manually following these steps: https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow
For now, please try not to manually run screener unless absolutely necessary. We only have around 35 runs per month at our current snapshot count. We will be working to reduce the number of stories so we can reenable screener PR checks in the short term.