flemay/cookiecutter repository overview

⁠Docker - Cookiecutter

Docker image of the latest version of Cookiecutter⁠, always!

⁠What's inside the image

• Based on the latest Python Alpine image⁠
• Latest version of Cookiecutter⁠
• Git
• OpenSSH

⁠Usage

# pull image
$ docker pull flemay/cookiecutter

# use the image to generate from a Cookiecutter template
$ docker run -it --rm \
    -v $PWD:/opt/app \
    -w /opt/app \
    flemay/cookiecutter \
    https://github.com/3musketeersio/cookiecutter-musketeers-go.git

# or
$ docker run -it --rm \
  -v $PWD:/opt/app \
  -v $HOME/.ssh:/root/.ssh:ro \
  -w /opt/app \
  flemay/cookiecutter \
  [email protected]:3musketeersio/cookiecutter-musketeers-go.git

⁠Development

# generate .env file
$ make envfile
# build image
$ make build
# test image
$ make test
# go inside the container
$ make shell
# call docker hub build
$ make push
# clean
$ make clean

⁠Versioning

This image will always be built with the tag latest so tools will always be up to date. This may cause issues if any tool has a breaking change.

⁠Automated build process

A change to master triggers a GitHub Action that builds, tests, and pushes the image to Docker Hub. The automatic build on Docker Hub has been disabled ensuring the build process to only go through GitHub Actions. Moreover, to make sure the image is always up to date, a scheduled GitHub Action kicks off every month. Finally, a pull request triggers another GitHub Action which builds and tests the image.

⁠Contributing

Contributions are greatly appreciated. Everyone can contribute and here⁠ are different ways.

⁠License

MIT⁠