CircleCI

This guide assumes you have a working static website project on your machine integrated with DatoCMS

If that's not your case, you can return to the previous sections of this documentation to see how to properly configure the DatoCMS administrative area and how to integrate DatoCMS with your favorite static website generator.

Create your Git repository

Create a new repository on GitHub. To avoid errors, do not initialize the new repository with README, license, or gitignore files. You can add these files after your project has been pushed to GitHub.

$ git init
$ git add .

Commit the files that you've staged in your local repository.

$ git commit -m 'First commit'

At the top of your GitHub repository's Quick Setup page, click the clipboard icon to copy the remote repository URL. In Terminal, add the URL for the remote repository where your local repository will be pushed.

$ git remote add origin YOUR_GITHUB_REPOSITORY_URL

Now, it's time to push the changes in your local repository to GitHub.

git push -u origin master

Now that your project is up and running on GitHub, let's connect it to CircleCI.

Enable CircleCI

Sign in to CircleCI and add a new project for the repository you want to build clicking on the Set Up project button and then build.

Add the DatoCMS API token as environment variable

Reach the settings page of your new CircleCI project, and add an environment variable called DATO_API_TOKEN containing the read-only API token of your DatoCMS administrative area:

You can find the API token in the Admin area > API tokens section:

Configure circle.yml

The next step is to add a circle.yml file to your repository. CircleCI uses this file in the root of your repository to learn about your project and how you want your builds to be executed. How this file needs to be structured differs a lot depending on the static website generator you are using. Here we'll show you some examples to get started.

Please refer to the official CircleCI documentation to learn everything regarding how to configure your build and how to properly deploy the actual website to S3.

Jekyll

1
test:
2
  override:
3
    # first dump all the remote content as local files
4
    - bundle exec dato dump
5
    # then generate the website
6
    - bundle exec dato jekyll build
7
deployment:
8
  production:
9
    branch: master
10
    commands:
11
      - aws s3 sync public s3://metalsmith-demo/ --delete

Hugo

1
machine:
2
  node:
3
    version: 6.7.0
4
dependencies:
5
  override:
6
    # if your project uses Yarn as package manager, replace "npm install" with "yarn"
7
    - npm install
8
    # download latest version of hugo
9
    - wget https://github.com/spf13/hugo/releases/download/v0.19/hugo_0.19-64bit.deb
10
    # install it
11
    - sudo dpkg -i hugo*.deb
12
test:
13
  override:
14
    # first dump all the remote content as local files
15
    - ./node_modules/.bin/dato dump
16
    # then generate the website
17
    - hugo
18
deployment:
19
  production:
20
    branch: master
21
    commands:
22
      - aws s3 sync public s3://your-bucket-name/ --delete

Middleman

test:
  override:
    - bundle exec middleman build
deployment:
  production:
    branch: master
    commands:
      - aws s3 sync build s3://metalsmith-demo/ --delete

Metalsmith

1
machine:
2
  node:
3
    version: 6.7.0
4
# if your project uses Yarn as package manager, uncomment these lines:
5
# dependencies:
6
#   override:
7
#     - yarn
8
test:
9
  override:
10
    # first dump all the remote content as local files
11
    - ./node_modules/.bin/dato dump
12
    # then generate the website
13
    - node index.js
14
deployment:
15
  production:
16
    branch: master
17
    commands:
18
      - aws s3 sync build s3://your-bucket-name/ --delete

Connect CircleCI to DatoCMS

There's only one last step needed: connecting DatoCMS to CircleCI, so that everytime one of your editors press the Publish changes button in your administrative area, a new build process (thus a new publication of the final website) gets triggered.

To do so, create a new deployment environment in the Admin area > Environments, select CircleCI and follow the instructions to conclude the integration:

When everything is done, confirm the integration pressing the Save Settings button.