Created: Apr, 2016
This tutorial also applies to building and deploying static websites to AWS S3 in general with minor changes.
Hugo is a fantastic static website generator. AWS S3 can be a top-notch solution of serving static websites. However, building such a Hugo site and deploying it to AWS S3 needs some non-trivial steps with certain toolchains. Here, continous integration (CI) service comes in to save. Fortunately, many high-quality CI services are free to use with basic-tier plans, and Wercker is one of them.
By the end of this tutorial, you should be able to push your Hugo source to a remote git repository (Github or Bitbucket for now), and your website hosted on AWS S3 should be automated updated with the latest content.
The idea is simple:
This is how “continuous integration” works in general.
Two things need to be done:
The Wercker automation runs like a multi-stage pipeline: dev -> build -> deploy. But we only use “build” and “deploy” stages here. This pipeline is decribed in the “wercker.yml” YAML file in the root directory. So create such a “wercker.yml” file with content like
The above file is divided to two parts:
More s3sync options can be found here.
Now add, commit and push the code to the remote repository.
Sign in to Wercker (or sign up if you haven’t), and click “
Create” -> “
Application” to create a new Wercker app. This process will connect Wercker with your Github or Bitbucket where the Hugo source resides in, and also configure the access to the repository. For a public repository, Wercker will just pull via https every time. But if the repository is private, Wercker will automatically add its SSH public key to your Github or Bitbucket account. Not quite a hassle – just follow the instructions.
It is time to specify the value of the environmental variables in
wercker.yml in Wercker as follows.
Application” tab in the top -> click on the Wercker app you just created -> click on “
Settings” in the upper right corner. Now do two things:
Environmental variables”, and add
AWS_ACCESS_S3_KEY_SECRETenvironmental variables with corresponding values. Be sure to check the “
protect” boxes so the sensitive information is protected.
Targets”, and add a deploy target. The deploy target name can be anything meaningful such as “production”, “release”, or “development”. If automatic deploy is needed, check the “Auto deploy” box, and specify the git branch that trigger(s) such a deploy. Below that, create an environmental “
AWS_S3_BUCKET_URL” with valid value, which is generally in form of “
One can see environmental variables can be set in both. The difference is the former is application-wide, while the latter is restricted to the deploy stage.
Go to the Wercker app page, and trigger a build job. After it is done, trigger a deploy job to a target if automatic deploy is not set. You will also trigger such a event chain by pushing a new commit to the git repository on Github or Bitbucket.
This is awesome. You should try it.