Gatsby WP Themes Documentation

Deploying your site

Deploying your site

The Gatsby documentation explains in details the deployment process. You will find there a variety of possibilities.
You should definitely consider deploying on Gatsby Cloud, the cloud platform specifically built by Gatsby for the Gatsby framework.

Right below, we will describe step-by-step the deployment process on Gatsby Cloud and Netlify.

In both cases you need to have a remote repository for your project. Your repository can be private or public. We'll use GitHub here.

The screenshot of a GitHub repo with yarn.lock file

✅ Given that our starters require yarn to work, make sure to have yarn.lock in your starter's GitHub repository. The yarn.lock file is automatically added when you first install your dependencies with the yarn command.

Deploying on Gatsby Cloud

  1. Sign-up to Gatsby Cloud with your GitHub account.

  2. Click the Add a site + button on your Dashboard. Screenshot from the Gatsby Cloud dashboard with the Add a site + button

  3. Choose the Import from a Git repository option Screenshot from the Gatsby Cloud dashboard with the Import from a Git repository panel selected

  4. Select your Git provider, GitHub in our case. Then selecto the starter's repository.

    You will have to authorize Gatsby Cloud to access your respository. (You can always modify the configuration in your GitHub Settings Installations)

    Screenshot from the Gatsby Cloud dashboard with your repository chosen

  5. Skip the integration step

  6. Gatsby Cloud list the environmental variables that were automatically detected. Make sure to fill in the the value for the required GATSBY_WP_URL. You also have to provide your secret auth token GWPT_AUTH_TOKEN here. Screenshot from the Gatsby Cloud dashboard with the list of environmental variables

Deploying on Netlify

  1. Sign-up to Netlify with your GitHub account.
  2. Click the New Site from Git button Screenshot from the Netlify dashboard with the New Site from Git button
  3. Choose your Git provider, GitHub in our case. Screenshot from the Netlify dashboard - the choose your Git provider screen
  4. Choose your GitHub repo (you will need authorize Netlify to access it). Screenshot from the Netlify dashboard - choose your GitHub repo
  5. In the configuration screen, choose:
    • your branch to deploy - each time you push to this branch, your site will be rebuilt
    • the build command: yarn build (or gatsby build)
    • your publish directory: public
    • open the Advanced build settings panel to add your environment variables. Paste all the variables you set in your .env file as well as the secret auth token GWPT_AUTH_TOKEN.
      Your build requires two environment variables GWPT_AUTH_TOKEN and GATSBY_WP_URL. Screenshot from the Netlify dashboard - the site settings
  6. Click the Deploy site button, the process can take a few minutes.
  7. Finally in Site settings > Domain management you can change the subdomain (by default it's some random string like modes-gates-51b250). You can also add your own custom. Screenshot from the Netlify dashboard - the site settings > Domain management tab

Prev

Shadowing

On this page