Skip to content

Latest commit

 

History

History
219 lines (154 loc) · 9.25 KB

README.md

File metadata and controls

219 lines (154 loc) · 9.25 KB
Raw

CircleCI Logo Docker Logo Gotham Logo

Strawberry Static Site Generator Docker Image

A Continuous Integration focused Strawberry Docker image built to run on CircleCI

CircleCI Build Status Software License Docker Pulls

While this image was designed with CircleCI in mind, it can be used with other CI providers that offer Docker support.

hubci/strawberry is a Docker image created with continuous integration builds in mind. Each tag contains a Strawberry version (matching the tag), tools for testing such as HTML-Proofer, and any binaries and tools that are required for builds to complete successfully in a CircleCI environment. Strawberry used to be called Gotham. Thus this image used to be called hubci/gotham.

Table of Contents

Getting Started

This image can be used with the CircleCI docker executor. For example:

version: 2.1
jobs:
  build:
    docker:
      - image: hubci/strawberry:0.14
    steps:
      - checkout
      - run:
          name: "Build with Strawberry"
          command: HUGO_ENV=production strawberry -v
      - run:
          name: "Test Website"
          command: htmlproofer ./public --allow-hash-href --check-html --empty-alt-ignore --disable-external

In the above example, the HubCI Strawberry Docker image is used as the primary container. More specifically, the tag 0.14 is used meaning the version of Strawberry will be Strawberry v0.14.x, with 'x' being the latest patch release. You can now use Strawberry within the steps for this job.

How This Image Works

This image contains the static site generator Strawberry and related testing tools such as HTML-Proofer. You can build your static site with this image, test it, and optionally ship it somewhere.

Variants

This image has a Node.js variant. Variant images typically contain the same base software, but with a few additional modifications. The Node.js variant is the same Strawberry image but with Node.js also installed. The Node.js variant can be used by appending -node to the end of an existing hubci/strawberry tag.

Tagging Scheme

This image has the following tagging scheme:

hubci/strawberry:<strawberry-version>[-variant]

<strawberry-version> - The version of Strawberry to use. This can be a full SemVer point release (such as 1.12.7) or just the minor release (such as 1.12). If you use the minor release tag, it will automatically point to future patch updates as they are released by the Strawberry Team. For example, the tag 0.14 points to Gotham v0.14.0 now, but if and when a patch release comes out, it will point to Strawberry v0.14.1.

[-variant] - Variant tags, if available, can optionally be used. The Node.js variant is available, it can be used like this: hubci/strawberry:0.14-node.

Development

Images can be built and run locally with this repository. This has the following requirements:

  • local machine of Linux (Ubuntu tested) or macOS
  • modern version of Bash (v4+)
  • modern version of Docker Engine (v19.03+)

Cloning For Community Users (no write access to this repository)

Fork this repository on GitHub. When you get your clone URL, you'll want to add --recurse-submodules to the clone command in order to populate the Git submodule contained in this repo. It would look something like this:

git clone --recurse-submodules <my-clone-url>

If you missed this step and already cloned, you can just run git submodule update --recursive to populate the submodule. Then you can optionally add this repo as an upstream to your own:

git remote add upstream https://github.com/hubci/strawberry-docker.git

Cloning For Maintainers ( you have write access to this repository)

Clone the project with the following command so that you populate the submodule:

git clone --recurse-submodules [email protected]:hubci/strawberry-docker.git

Generating Dockerfiles

Dockerfiles can be generated for a specific Strawberry version using the gen-dockerfiles.sh script. For example, to generate the Dockerfile for Strawberry v0.14.0, you would run the following from the root of the repo:

./shared/gen-dockerfiles.sh 0.14.0

The generated Dockerfile will be located at ./0.14/Dockefile. To build this image locally and try it out, you can run the following:

cd 0.14
docker build -t test/strawberry:0.14.0 .
docker run -it test/strawberry:0.14.0 bash

Building the Dockerfiles

To build the Docker images locally as this repository does, you'll want to run the build-images.sh script:

./build-images.sh

This would need to be run after generating the Dockerfiles first. When releasing proper images as HubCI, this script is run from a CircleCI pipeline and not locally.

Publishing Official Images (for Maintainers only)

The individual scripts (above) can be used to create the correct files for an image, and then added to a new git branch, committed, etc. A release script is included to make this process easier. To make a proper release for this image, let's use the fake Strawberry version of Strawberry v9.99, you would run the following from the repo root:

./shared/release.sh 9.99

This will automatically create a new Git branch, generate the Dockerfile(s), stage the changes, commit them, and push them to GitHub. The commit message will end with the string [release]. This string is used by CircleCI to know when to push images to Docker Hub. All that would need to be done after that is:

  • wait for build to pass on CircleCI
  • review the PR
  • merge the PR

The master branch build will then publish a release.

Incorporating Changes

How changes are incorporated into this image depends on where they come from.

build scripts - Changes within the ./shared submodule happen in its own repository. For those changes to affect this image, the submodule needs to be updated. Typically like this:

cd shared
git pull
cd ..
git add shared
git commit -m "Updating submodule for foo."

parent image - By design, when changes happen to a parent image, they don't appear in existing Strawberry images. This is to aid in "determinism" and prevent breaking user builds. New Strawberry images will automatically pick up the changes.

If you really want to publish changes from a parent image into the Strawberry image, you have to build a specific image version as if it was a new image. This will create a new Dockerfile and once published, a new image.

Strawberry specific changes - Editing the Dockerfile.template file in this repo will modify the Strawberry image specifically. Don't forget that to see any of these changes locally, the gen-dockerfiles.sh script will need to be run again (see above).

Contributing

We encourage issues and pull requests against this repository. In order to value your time, here are some things to consider:

  1. We won't include just anything in this image. In order for us to add a tool within the Strawberry image, it has to be something that is maintained and useful to a large number of Strawberry users. Every tool added makes the image larger and slower for all users so being thorough on what goes in the image will benefit everyone.
  2. PRs are welcome. If you have a PR that will potentially take a large amount of time to make, it will be better to open an issue to discuss it first to make sure it's something worth investing the time in.
  3. Issues should be used to report bugs or request additional/removal of tools in this image.

Additional Resources

Strawberry Website - The official Strawberry website. Still under construction. CircleCI Docs - The official CircleCI Documentation website.
CircleCI Configuration Reference - From CircleCI Docs, the configuration reference page is one of the most useful pages we have. It will list all of the keys and values supported in .circleci/config.yml.
Docker Docs - For simple projects this won't be needed but if you want to dive deeper into learning Docker, this is a great resource.

License

This repository is licensed under the MIT license. The license can be found here.