mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
e98620ee99
Issue number: Internal --------- <!-- Please do not submit updates to dependencies unless it fixes an issue. --> <!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying. --> The team currently faces two challenges: 1. Verifying visual changes locally is difficult because we cannot use the existing ground truths as they were generated in Linux environments and most of our team uses either macOS or Windows. While team members can generate ground truths in the correct environment, they need to remember to do that first before making changes. 2. Updating visual diffs is time consuming and can only be done by team members. Our GitHub Action runs the entire test suite which can take ~10 even if only a handful of screenshots are generated. Additionally, this job can only be run by team members meaning community contributors cannot update/add screenshots. This limits them to non-visual tasks when contributing. In the event that they do want to make visual changes, the team needs to copy all their code into a branch and manually run screenshot diffs for them. ## What is the new behavior? <!-- Please describe the behavior or changes that are being added by this PR. --> - This PR introduces the ability to run all Playwright tests inside of a Docker container using an image with Playwright dependencies. The container will have access to the local project, so developers can make changes and then run tests in the container after the changes are compiled. This enables anyone to propose new screenshot changes. However, the "update screenshot" job will still be available for folks who do not want/are unable to use docker. - There are some typeface differences between GH Actions and the Docker image which is why there are a handful of screenshots that needed to be updated. One risk here is that the Playwright npm and Docker image versions must be kept in sync. As a result, I also updatRenovate to allow us to auto update the npm and Docker image versions at the same time. ## Does this introduce a breaking change? - [ ] Yes - [x] No <!-- If this introduces a breaking change: 1. Describe the impact and migration path for existing applications below. 3. Update the BREAKING.md file with the breaking change. 4. Add "BREAKING CHANGE: [...]" to the commit description when merging. See https://github.com/ionic-team/ionic-framework/blob/main/.github/CONTRIBUTING.md#footer for more information. --> ## Other information <!-- Any other information that is important to this PR such as screenshots of how the component looks before and after the change. --> ⚠️ There are still some issues I need to sort out with mounting the local project on Windows. However, using Ubuntu with the linux subsystem for windows can be used as a workaround. I'd like to merge this so we can start testing it in our day-to-day workflow and ironing out any bugs. --------- Co-authored-by: ionitron <hi@ionicframework.com>
55 lines
1.8 KiB
YAML
55 lines
1.8 KiB
YAML
name: 'Update Reference Screenshots'
|
||
description: 'Update Reference Screenshots'
|
||
|
||
on:
|
||
workflow_dispatch:
|
||
|
||
runs:
|
||
using: 'composite'
|
||
steps:
|
||
- uses: actions/setup-node@v4
|
||
with:
|
||
node-version: 18.x
|
||
- uses: actions/download-artifact@v4
|
||
with:
|
||
path: ./artifacts
|
||
- name: Extract Archives
|
||
# This finds all .zip files in the ./artifacts
|
||
# directory, including nested directories.
|
||
# It then unzips every .zip to the root directory
|
||
run: |
|
||
find . -type f -name 'UpdatedScreenshots-*.zip' -exec unzip -q -o -d ../ {} \;
|
||
shell: bash
|
||
working-directory: ./artifacts
|
||
- name: Push Screenshots
|
||
# Configure user as Ionitron
|
||
# and push only the changed .png snapshots
|
||
# to the remote branch.
|
||
# Non-Linux screenshots are in .gitignore
|
||
# to prevent local screenshots from getting
|
||
# pushed to Git.
|
||
run: |
|
||
git config user.name ionitron
|
||
git config user.email hi@ionicframework.com
|
||
|
||
# This adds an empty entry for new
|
||
# screenshot files so we can track them with
|
||
# git diff
|
||
git add src/\*.png -N
|
||
|
||
if git diff --exit-code; then
|
||
echo -e "\033[1;31m⚠️ Error: No new screenshots generated ⚠️\033[0m"
|
||
echo -e "\033[1;31mThis means that there were zero visual diffs when running screenshot tests.\033[0m"
|
||
echo -e "\033[1;31mMake sure you have pushed any code changes that would result in visual diffs.\033[0m"
|
||
exit 1
|
||
else
|
||
# This actually adds the contents
|
||
# of the screenshots (including new ones)
|
||
git add src/\*.png
|
||
git commit -m "chore(): add updated snapshots"
|
||
git push
|
||
fi
|
||
|
||
shell: bash
|
||
working-directory: ./core
|