Development Guide
Start developing using remote, pre-configured environment within minutes.
Sorry Cypress supports remote development using GitHub Codespaces. All the services are pre-configured to run in a remote, containerized environment and allows starting developing within minutes.
Creating sorry-cypress Codespace
Within the Codespace, open a terminal and run
yarn && yarn dev
This command will start all the internal services and will expose the ports on localhost:
- 8080 - dashboard
- 1234 - director
- 4000 - API
- 9000 - minio
To start sending cypress tests to your dev instance, run:
CYPRESS_API_URL=http://localhost:1234/ && \
yarn cy2 run --parallel --record --key whatever
- Don't use broser-based VS Code to connect to a codespace - it doesn't allow access to sorry-cypress services via
localhost - If the services become unavailable via published ports, delete and re-add them in "Ports" tab of VS Code
- Run
yarn killall && yarn devto stop and start all the services - sometimes they hang and keep their ports busy
We use yarn workspaces, please use
yarn. Add
.env file with the following contents:# packages/director/.env
EXECUTION_DRIVER="../execution/mongo/driver"
SCREENSHOTS_DRIVER="../screenshots/minio.driver"
MINIO_ACCESS_KEY='MW32h3gd6HvjBEgTRx'
MINIO_SECRET_KEY=t6NgQWUcEyG2AzaDCVkN6sbWcvDCVkN6sGiZ7
MINIO_ENDPOINT='storage'
MINIO_URL='http://localhost'
MINIO_PORT='9000'
MINIO_USESSL='false'
MINIO_BUCKET=sorry-cypress
# packages/dashboard/.env
GRAPHQL_SCHEMA_URL=http://api.sc.com:4000
Add the following entries to
/etc/hosts or an equivalent file on Windows127.0.0.1 storage
127.0.0.1 api.sc.com
docker-compose -f ./docker-compose.minio.yml up -d storage mongo createbuckets
Make sure that associated services are available on the localhost - e.g.
mongo, minioyarn devSend new tests to dashboard using this command:
CYPRESS_API_URL=http://localhost:1234/ \
cy2 run --record --key whatever --parallel --ci-build-id `date +%s`
Add
[skip ci] to commit message to skip running CI.We use semver standard.
Every commit to master triggers CI via GH Actions, which builds new docker images, assign tags and pusher the new images to DockerHub.
After pushing a new tagged please go ahead and create a new Github release with a summary and attributions.
Pushing to master automatically created new docker images with
latest tags- 1.Run
yarn releaseto create a new release. - 2.Push to master. Push to master, together with tags
git push origin master --tags. Pushing to master will trigger CI that will actually update dockerhub.
Pushing a properly formatted (semver) git tag starts release of dockerhub images tagged accordingly. E.g.
v0.5.2 will release dockerhub tags v0, v0.5, v0.5.2.The script does the following behind the scenes:
- Update all
package.jsonfiles (we release all together and do not increase / release individual packages version) - Commit with message, e.g.
v0.5.2 - Add git tag, e.g.
git tag v0.5.2
Last modified 1yr ago