Skip to main content

Integrate Argos with Gatsby

Use gatsby-plugin-argos plugin to automatically take screenshots of every page of a Gatsby project and upload them on Argos.

Click here to see the Gatsby integration repository example.

Install​

npm install --save-dev gatsby-plugin-argos argos-cli gatsby-plugin-screenshot puppeteer

Set the repository token​

Follow this guide to set up the Argos token as an environment variable.

Update the Gatsby config​

// Example for GitHub Actions
module.exports = {
  plugins: [
    ...(process.env.CI
      ? [
          {
            resolve: "gatsby-plugin-argos",
            options: {
              token: process.env.ARGOS_TOKEN,

              // CI branch name variable
              branch: process.env.GITHUB_REF_NAME,

              // CI commit hash
              commit: process.env.GITHUB_SHA,
            },
          },
        ]
      : []),
  ],
};