Use Argos with GitLab CI
Configure GitLab CI to send screenshots to Argos visual testing platform.
1. Install Argos CLI
- npm
- yarn
- pnpm
npm i --save-dev @argos-ci/cli
yarn add --dev @argos-ci/cli
pnpm add --save-dev @argos-ci/cli
Read the CLI documentation if you need information about advanced usages.
2. Expose ARGOS_TOKEN
as environment variable
- Log in to Argos, navigate to your repository settings and copy your
ARGOS_TOKEN
. - In your GitLab repository, go to Settings -> CI/CD.
- Expand the Variables section.
- Add a new environment variable called
ARGOS_TOKEN
and paste the value you copied in the previous step.
If you are not comfortable with exposing environment variables, read Gitlab CI documentation.
3. Upload the screenshots
Add the following command to your CI workflow to upload screenshots to Argos:
- npm
- yarn
- pnpm
npx @argos-ci/cli upload ./screenshots
yarn run @argos-ci/cli upload ./screenshots
pnpm exec @argos-ci/cli upload ./screenshots
Complete example
.gitlab-ci.yml
script:
# 👉 Insert the steps required to take screenshots
# Upload screenshots to argos-ci.com
# 👇 change "./screenshots" by your screenshots folder path
- npx @argos-ci/cli upload ./screenshots
What's next?
Congratulations on installing Argos! 🎉
The next step is to integrate visual review into your development workflow. Visit our review changes section to learn how to.