PrivateCoffee/element-web
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

Disable Percy (#11852)

Browse source 
* Disable Percy

While visual regression testing is without doubt an essential part of
quality assurance, the way we're currently using Percy brings little
to no value while causing mainenance overhead. Therefore, we're disabling it
until we have figure out https://github.com/vector-im/wat-internal/issues/36
and https://github.com/vector-im/wat-internal/issues/56.

* Also disable nightly build

* Comment out Percy step instead of fiddling with the output value

* Appease the frigging linter
This commit is contained in:
Johannes Marbach 2023-11-10 22:25:18 +01:00 committed by GitHub
parent bef8aec483
commit 7a56d61a9e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 30 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
.github/workflows/cypress.yaml vendored
View file

@ -78,16 +78,19 @@ jobs:
core.setOutput("author", response.data.author.name);
core.setOutput("email", response.data.author.email);
# Only run Percy when it is demanded or we are running the daily build
- name: Enable Percy
id: percy
if: |
github.event.workflow_run.event == 'schedule' ||
(
github.event.workflow_run.event == 'merge_group' &&
contains(fromJSON(steps.prdetails.outputs.data).labels.*.name, 'X-Needs-Percy')
)
run: echo "value=1" >> $GITHUB_OUTPUT
# Percy is disabled while we're figuring out https://github.com/vector-im/wat-internal/issues/36
# and https://github.com/vector-im/wat-internal/issues/56. We're hoping to turn it back on or switch
# to an alternative in the future.
# # Only run Percy when it is demanded or we are running the daily build
# - name: Enable Percy
# id: percy
# if: |
# github.event.workflow_run.event == 'schedule' ||
# (
# github.event.workflow_run.event == 'merge_group' &&
# contains(fromJSON(steps.prdetails.outputs.data).labels.*.name, 'X-Needs-Percy')
# )
# run: echo "value=1" >> $GITHUB_OUTPUT
- name: Generate unique ID 💎
id: uuid

8
.github/workflows/element-web.yaml vendored
View file

@ -3,8 +3,12 @@
# as an artifact and run integration tests.
name: Element Web - Build
on:
schedule:
- cron: "17 4 * * 1-5" # every weekday at 04:17 UTC
# We only need the nightly run for Percy which is disabled while we're
# figuring out https://github.com/vector-im/wat-internal/issues/36 and
# https://github.com/vector-im/wat-internal/issues/56. We're hoping to
# turn it back on or switch to an alternative in the future.
# schedule:
# - cron: "17 4 * * 1-5" # every weekday at 04:17 UTC
pull_request: {}
merge_group:
types: [checks_requested]

7
README.md
View file

@ -2,7 +2,14 @@
![Tests](https://github.com/matrix-org/matrix-react-sdk/actions/workflows/tests.yml/badge.svg)
![Static Analysis](https://github.com/matrix-org/matrix-react-sdk/actions/workflows/static_analysis.yaml/badge.svg)
[![matrix-react-sdk](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/ppvnzg/develop&style=flat&logo=cypress)](https://dashboard.cypress.io/projects/ppvnzg/runs)
<!--
Percy is disabled while we're figuring out https://github.com/vector-im/wat-internal/issues/36
and https://github.com/vector-im/wat-internal/issues/56. We're hoping to turn it back on or switch
to an alternative in the future.
[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/dfde73bd/matrix-react-sdk)
-->
[![Localazy](https://img.shields.io/endpoint?url=https%3A%2F%2Fconnect.localazy.com%2Fstatus%2Felement-web%2Fdata%3Fcontent%3Dall%26title%3Dlocalazy%26logo%3Dtrue)](https://localazy.com/p/element-web)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=matrix-react-sdk&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=matrix-react-sdk)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=matrix-react-sdk&metric=coverage)](https://sonarcloud.io/summary/new_code?id=matrix-react-sdk)

4
docs/cypress.md
View file

@ -238,6 +238,10 @@ should generally try to adhere to them.
## Screenshot testing with Percy
**⚠️ Percy is disabled while we're figuring out https://github.com/vector-im/wat-internal/issues/36**
**and https://github.com/vector-im/wat-internal/issues/56. We're hoping to turn it back on or switch**
**to an alternative in the future.**
We also support visual testing via [Percy](https://percy.io). Within many of our
Cypress tests you can see lines calling `cy.percySnapshot()`. This creates a
screenshot and uses Percy to check whether it has changed from the last time