This repository is a template repository (a cookiecutter) that allows you to quickly set up new projects.
- Very simple, configurable setup of a fully functional project
- Based on an established tool: Cookiecutter has >13k stars on Github!
In order to use Docker Image Cookiecutter using GitLab CI you need the following software installed:
- Python
>= 3.6
- Cookiecutter e.g. by doing
pip install cookiecutter
. - Git
>= 1.8.2
Simply run the cookiecutter command line interface:
cookiecutter gh:joclement/docker-image-cookiecutter-using-gitlab-ci
This will start an interactive prompt that will configure and generate your project. One of the prompts will ask you for a remote repository URL, so you should head to the Git hosting service of your choice and add a new empty repository e.g. on Github.
This cookiecutter accepts the following configuration options:
project_name
: The human-readable name of the project, defaults toMy C++ Project
remote_url
: The remote URL for the newly created repository. This is not only used to add it as a remote to the Git repository, but also to enable integration with some services. Defaults toNone
although we strongly advise you to specify it.project_slug
: This will be the name of the generated directory.By default, it is deduced from the specified remote URL and the given project name.full_name
: Author name, defaults toYour Name
If you are using docker-image-cookiecutter-using-gitlab-ci
a lot, you can customize your default values
by providing a .cookiecutterrc
file in your home directory, for more details see the
cookiecutter documentation.
Please report any issues you might have with template using the Github issue tracker