Use Argos with CodeShip

Configure CodeShip to send screenshots to Argos visual testing platform.

1. Install Argos CLI

npm

npm i --save-dev @argos-ci/cli

yarn

yarn add --dev @argos-ci/cli

pnpm

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

1. Log in to Argos, navigate to your repository settings and copy your ARGOS_TOKEN.
2. In your CodeShip project go to Settings -> Environment Variables.
3. 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 CodeShip documentation.

3. Upload the screenshots

Add the following command to your CI workflow to upload screenshots to Argos:

npm

npx @argos-ci/cli upload ./screenshots

yarn

yarn run @argos-ci/cli upload ./screenshots

pnpm

pnpm exec @argos-ci/cli upload ./screenshots

Complete example

codeship-steps.yml

- name: ci
  type: parallel
  steps:
    - service: project_name
      # 👇 change "./screenshots" by your screenshots folder path
      command: 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.