https://github.com/joclement/docker-image-cookiecutter-using-gitlab-ci
A cookiecutter template to use when building Docker images with the Gitlab CI
https://github.com/joclement/docker-image-cookiecutter-using-gitlab-ci
cookiecutter docker gitlab gitlab-ci
Last synced: 6 months ago
JSON representation
A cookiecutter template to use when building Docker images with the Gitlab CI
- Host: GitHub
- URL: https://github.com/joclement/docker-image-cookiecutter-using-gitlab-ci
- Owner: joclement
- License: mit
- Created: 2023-12-06T17:20:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-05T08:50:52.000Z (almost 2 years ago)
- Last Synced: 2025-09-24T01:39:54.075Z (9 months ago)
- Topics: cookiecutter, docker, gitlab, gitlab-ci
- Language: Python
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: COPYING.md
Awesome Lists containing this project
README
# Welcome to Docker Image Cookiecutter using GitLab CI!
This repository is a template repository (a cookiecutter) that allows you to quickly
set up new projects.
# Features
- Very simple, configurable setup of a fully functional project
- Based on an established tool: [Cookiecutter](https://github.com/cookiecutter/cookiecutter) has >13k stars on Github!
# Prerequisites
In order to use Docker Image Cookiecutter using GitLab CI you need the following software installed:
- Python `>= 3.6`
- [Cookiecutter](https://github.com/cookiecutter/cookiecutter) e.g. by doing `pip install cookiecutter`.
- Git `>= 1.8.2`
# Using Docker Image Cookiecutter using GitLab CI
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](https://github.com/new).
# Configuration
This cookiecutter accepts the following configuration options:
- `project_name`: The human-readable name of the project, defaults to `My 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 to `None` 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 to `Your 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](https://cookiecutter.readthedocs.io/en/latest/advanced/user_config.html).
# Issues
Please report any issues you might have with template using [the Github issue
tracker](https://github.com/joclement/docker-image-cookiecutter-using-gitlab-ci)