eyes-scm

Allows to integrate source control systems (currently Bitbucket and GitHub) with Applitools without allowing Eyes to access the repos.

Getting started

$3

1. Make sure you have node 12 installed
1. Make sure you have yarn installed
1. Run npm i -g @applitools/eyes-scm
1. Get your Eyes organization ID: Go to your Eyes admin panel > Account page, and copy your organization ID (under GENERAL, ID).
1. Add the following environment variables (you can use a .env file in the root folder):

- EYES_SERVER_URL=https://eyes.applitools.com
- EYES_ORG_ID=
- EYES_SCM_PROXY_URL=http://
- optionally: PORT=
- GITHUB_WEBHOOK_SECRET= - Only for cases where the events proxy is used.

All done!

_Notes:_

- You’ll need a team admin user
- You’ll need to create an API key for this user with full privileges
- You’ll need an admin user in BitBucket or GitHub (depending on the system you use)

$3

run eyes-scm
and navigate to localhost:4000 (or your PORT_NUMBER)

$3

For github only it is possible to use the eyes-scm service as a proxy for transferring webhook events to Eyes server. This allows users with strict network restrictions on their GitHub enterprise server to use Applitools GitHub integation.

The API endpoint is

``
POST /api/github-events-proxy
`

In order to use it, the webhook secret has to be provided to eyes-scm via the environment variable GITHUB_WEBHOOK_SECRET.
In addition, the GitHub app should be configured to send all the webhook events to
(eyes-scm-url)/api/github-events-proxy?serverId=&orgId=

$3

In order to use MSSQL server instead of the default SQLite
Some additional environment variables have to be provided:

- USE_MSSQL=true
- MSSQL_DB_NAME
- MSSQL_DB_HOST
- MSSQL_DB_ENCRYPT (true/false)
- MSSQL_DB_PORT
- MSSQL_DB_PASSWORD
- MSSQL_DB_USERNAME

#### Authentication using Azure Active Directory:

In order to authenticate using Active Directory (client ID and secret)
Instead of MSSQL_DB_USERNAME and MSSQL_DB_PASSWORD, define the following environment variables:

- MSSQL_AUTH_TYPE=azure-active-directory-service-principal-secret
- MSSQL_AD_CLIENT_ID
- MSSQL_AD_CLIENT_SECRET
- MSSQL_AD_TENANT_ID

$3

From the root folder run yarn devel
It will fire up the react app build scripts and the nodemon that will restart the process following relevant changes.

Releasing a New Version

$3

`bash


Bump version (choose one)

yarn version:patch # 1.0.0 -> 1.0.1
yarn version:minor # 1.0.0 -> 1.1.0
yarn version:major # 1.0.0 -> 2.0.0

Push to trigger release

yarn release
`

$3

1. Go to Actions > Release workflow
2. Click "Run workflow"
3. Optionally specify version or enable dry-run mode
4. Click "Run workflow"

$3

When you push a version tag (e.g., v1.0.30`), GitHub Actions will:

1. Run tests
2. Build the client
3. Publish to npm with provenance attestation
4. Create a GitHub release with auto-generated release notes