@sonarsource/marketing-gatsby-boilerplate

Boilerplate commands

Purpose

• Initialize a new Gatsby/Kentico Kontent/Netlify project while respecting the Martech team standards
• Streamline development (Git workflow, Netlify synchronization, Kentico Kontent environments)
• (To be implemented) Allow for easy update of existing projects using the boilerplate

How to use it

You can see the list of commands by running npx @sonarsource/marketing-gatsby-boilerplate -h.

for reach command, you can obtain even more informations on it (arguments, options, etc) by running npx @sonarsource/marketing-gatsby-boilerplate COMMAND -h (example: npx @sonarsource/marketing-gatsby-boilerplate release -h)

Table of contents

• Getting started
• Commands
• Migrations
• Gatsby
  • Templates
  • Components
• Testing
  • Unit / Functional tests
  • E2E tests
• Styling

Commands

Create an environment

After creating a branch, you can create an environment dedicated to it by running the environment --create --scope production or environment --create --scope develop command, depending on the environment you want to work from. If an environment already exists, you'll be asked wether to use it, or delete and re-create it.

This new environment will be yours to play with, creating migrations, modifying content, etc.

Finish an environment

Once done with your changes, you will need to run the environment --finish command. This command will delete your Kontent environment, and run any new migrations you have created against the source environment (a.k.a the environment your environment was cloned from).

Release --create and --finish

For these, see the Release process

Troubleshooting

Netlify Forbidden error

Error:

Solution:

Log out of Netlify using yarn netlify logout, and re-run your command. Also make sure the account you are logging in has access to the Netlify projects setup in the status.json file