initial commit

.gitignore

+### STS ###
+.apt_generated
+.classpath
+.factorypath
+.project
+.settings
+.springBeans
+.sts4-cache
+
+### IntelliJ IDEA ###
+.idea
+*.iws
+*.iml
+*.ipr
+
+### NetBeans ###
+/nbproject/private/
+/build/
+/nbbuild/
+/dist/
+/nbdist/
+/.nb-gradle/
+.DS_Store

.gitlab-ci.yml

+include:
+  - project: 'to-be-continuous/tools/gitlab-ci'
+    ref: 'master'
+    file: '/templates/extract.yml'
+  - project: 'to-be-continuous/tools/gitlab-ci'
+    ref: 'master'
+    file: '/templates/validation.yml'
+  - project: 'to-be-continuous/kicker'
+    ref: 'master'
+    file: '/templates/validation.yml'
+  - project: 'to-be-continuous/bash'
+    ref: '3.3'
+    file: '/templates/gitlab-ci-bash.yml'
+  - project: 'to-be-continuous/semantic-release'
+    ref: '3.7'
+    file: '/templates/gitlab-ci-semrel.yml'    
+
+stages:
+  - build
+  - publish
+
+variables:
+  GITLAB_CI_FILES: "templates/gitlab-ci-docker-compose.yml"
+  BASH_SHELLCHECK_FILES: "*.sh"
+
+semantic-release:
+  rules:
+    # on production branch(es): auto if SEMREL_AUTO_RELEASE_ENABLED
+    - if: '$TMPL_RELEASE_ENABLED == "true" && $CI_COMMIT_REF_NAME =~ $PROD_REF'
\ No newline at end of file

.gitlab/issue_templates/bug_report.md

+## Describe the bug
+
+(Describe the problem clearly and concisely.)
+
+
+## Expected behavior
+
+(Describe the expected behavior clearly and concisely.)
+
+
+## Actual behavior
+
+(Describe the actual behavior clearly and concisely.)
+
+
+## Logs and/or screenshots
+
+(Join any relevant logs and/or screenshot. Please use code blocks (```) to format console output, logs, and code.)
+
+
+## Context & Configuration
+
+Link to a project, pipeline or job facing the bug: (please provide one if possible)
+
+The issue was reproduced using:
+
+* Version of the template: (type in the version)
+* GitLab server(s): (Was it gitlab.com? A self-managed server? Which version? CE / EE? Which license?)
+* GitLab runner(s): (type in any relevant information about the GitLab runner(s) you used)
+
+
+Here is the `.gitlab-ci.yml` file:
+
+```yaml
+# Add your .gitlab-ci.yml here, if applicable and useful.
+
+```
+
+(If useful, list configured GitLab CI project and/or group variables.)
+
+Configured GitLab CI project or group variables:
+
+* `VARIABLE_1`
+* `VARIABLE_2`
+* ...
+
+
+(Finally add any possible additional useful context info here.)
+
+
+
+
+/label ~"kind/bug" ~"status/needs-investigation"

.gitlab/issue_templates/feature_request.md

+## Description
+
+(Describe the feature clearly and concisely.)
+
+## Implementation ideas
+
+(If you have any implementation ideas, they can go here.)
+(Any design change proposal could be also discussed on the _to be continuous_ Discord server.)
+
+
+/label ~"kind/enhancement" ~"status/needs-investigation"

.gitlab/merge_request_templates/bug_fix.md

+## Presentation
+
+(Necessarily link to an issue. If it doesn't exist, please create one.)
+
+Fixes #999
+
+## Checklist
+
+* Documented:
+    * [ ] `README.md` reflects any job, variable or whichever visible change
+    * [ ] `kicker.json` reflects any job, variable or whichever visible change
+* Tested & examplified:
+    * [ ] (url to a project sample successfully proving the merge request fixes the issue)
+
+/label ~"kind/fix"

.gitlab/merge_request_templates/new_feature.md

+## Presentation
+
+(Necessarily link to an issue. If it doesn't exist, please create one.)
+
+Closes #999
+
+
+## Checklist
+
+* General:
+    * [ ] use [rules](https://docs.gitlab.com/ee/ci/yaml/#rules) instead of [only/except](https://docs.gitlab.com/ee/ci/yaml/#onlyexcept-advanced)
+    * [ ] optimized [cache](https://docs.gitlab.com/ee/ci/caching/) configuration (wherever applicable)
+* Publicly usable:
+    * [ ] untagged runners
+    * [ ] no proxy configuration but support `http_proxy`/`https_proxy`/`no_proxy`
+    * [ ] no custom CA certificate(s) but supports `$CUSTOM_CA_CERTS` or `$DEFAULT_CA_CERTS` to declare custom CA certificate(s)
+    * [ ] internet hostnames/urls only
+* Used Docker images:
+    * [ ] **public** images
+    * [ ] **official** images (when possible)
+    * [ ] `latest` tag (when possible)
+* Documented:
+    * [ ] `README.md` documents the new feature
+    * [ ] `kicker.json` describes the new feature
+* Tested & examplified:
+    * [ ] (url to a project sample successfully using the new feature)
+
+
+/label ~"kind/enhancement"

.releaserc.yml

+plugins: [
+  "@semantic-release/commit-analyzer",
+  "@semantic-release/release-notes-generator",
+  "@semantic-release/gitlab",
+  "@semantic-release/changelog",
+  [
+    "@semantic-release/exec",
+    {
+      "prepareCmd": "./bumpversion.sh \"${lastRelease.version}\" \"${nextRelease.version}\" \"${nextRelease.type}\"",
+      "successCmd": "./post-release.sh \"${nextRelease.version}\""
+    }
+  ],
+  [
+    "@semantic-release/git",
+    {
+      "assets": ["*.md", "templates/*.yml"]
+    }
+  ]
+]
+branches:
+  - "main"
+tagFormat: "${version}"
\ No newline at end of file

CONTRIBUTING.md

+# Contributors guide
+
+**Want to contribute? Great!**
+We try to make it easy, and all contributions, even the smaller ones, are more than welcome.
+This includes bug reports, fixes, documentation, examples...
+But first, read this page (including the small print at the end).
+
+Contributions are available on https://gitlab.com/to-be-continuous/docker-compose.
+
+## Legal
+
+All original contributions to _to be continuous_ are licensed under the
+[GNU Lesser General Public License](https://www.gnu.org/licenses/lgpl-3.0.html),
+version 3.0 or later.
+
+All contributions are subject to the [Developer Certificate of Origin](https://developercertificate.org/) (DCO).
+The DCO is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.
+The DCO text is also included verbatim in the [DCO.txt](DCO.txt) file in the root directory of the repository.
+
+Contributors **must** _sign-off_ that they adhere to these requirements by adding a `Signed-off-by` line to commit messages, as shown below:
+
+```text
+This is the commit message
+
+Signed-off-by: John Dev <john.dev@developer.example.org>
+```
+
+Git has a handy [`-s` command line option](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff) to append this automatically to your commit message:
+
+```bash
+$ git commit -s -m 'This is the commit message'
+```
+
+## Reporting an issue
+
+This project uses GitLab issues to manage the issues.
+
+Before creating an issue:
+
+1. upgrade your project to the latest released template version, and check whether your bug is still present,
+2. have a look in the opened issues if your problem is already known/tracked, and possibly contribute to the thread with your own information.
+
+If none of the above was met, open an issue directly in GitLab, select the appropriate issue template and fill-in each section when applicable.
+
+## Submitting a code change
+
+### Git Setup
+
+Before contributing, make sure you have set up your Git authorship correctly:
+
+```bash
+git config --global user.name "Your Full Name"
+git config --global user.email your.email@example.com
+```
+
+### Workflow
+
+All submissions, including submissions by project members, need to be reviewed before being merged.
+
+To contribute:
+
+1. Create an issue describing the bug or enhancement you want to propose (select the right issue template).
+2. Make sure the issue has been reviewed and agreed.
+3. Create a Merge Request, from your **own** fork (see [forking workflow](https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html) documentation).
+   Don't hesitate to mark your MR as `Draft` as long as you think it's not ready to be reviewed.
+
+### Git Commit Conventions
+
+In addition to being signed-off according the [Developer Certificate of Origin](https://developercertificate.org/) (see above),
+Git commits in _to be continuous_ shall be:
+
+1. **atomic** (1 commit `=` 1 and only 1 _thing_),
+2. **semantic** (using [semantic-release commit message syntax](https://semantic-release.gitbook.io/semantic-release/#commit-message-format)).
+
+You'll find extensive information about Git commit conventions on the [reference documentation website](https://to-be-continuous.gitlab.io/doc/dev/workflow/#git-commit-guidelines).
+
+### Coding Guidelines
+
+The extensive _to be continuous_ coding guidelines can be found on the [reference documentation website](https://to-be-continuous.gitlab.io/doc/dev/guidelines/).

DCO.txt

+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
\ No newline at end of file

Docker Compose.r2.yml

+files:
+    template: ./templates/gitlab-ci-docker-compose.yml
+    documentation: ./README.md
+    changelog: ./CHANGELOG.md
+data:
+    description: "Deploy your application with Docker Compose"
+    labels:
+    - to be continuous
+    - Deploy
+    - Docker Compose
+    public: true
+    license: LGPL v3
+    deprecated: false

LICENSE.txt

+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
\ No newline at end of file

README.md

+# GitLab CI template for Docker Compose
+
+This project implements a GitLab CI/CD template to deploy your application with [Docker Compose](https://docs.docker.com/compose/).
+
+## Usage
+
+This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component-in-a-cicd-configuration) 
+or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.
+
+### Use as a CI/CD component
+
+Add the following to your `gitlab-ci.yml`:
+
+```yaml
+include:
+  # 1: include the component
+  - component: gitlab.com/to-be-continuous/docker-compose/gitlab-ci-docker-compose@1.0.0
+    # 2: set/override component inputs
+    inputs:
+      # ⚠ this is only an example
+      base-app-name: wonderapp
+      review-project: "prj-12345" # enable review env
+      staging-project: "prj-12345" # enable staging env
+      prod-project: "prj-12345" # enable production env
+```
+
+### Use as a CI/CD template (legacy)
+
+Add the following to your `gitlab-ci.yml`:
+
+```yaml
+include:
+  # 1: include the template
+  - project: 'to-be-continuous/docker-compose'
+    ref: '1.0.0'
+    file: '/templates/gitlab-ci-docker-compose.yml'
+
+variables:
+  # 2: set/override template variables
+  # ⚠ this is only an example
+  DCMP_BASE_APP_NAME: wonderapp
+  DCMP_REVIEW_PROJECT: "prj-12345" # enable review env
+  DCMP_STAGING_PROJECT: "prj-12345" # enable staging env
+  DCMP_PROD_PROJECT: "prj-12345" # enable production env
+```
+
+## Understand
+
+This chapter introduces key notions and principle to understand how this template works.
+
+### Managed deployment environments
+
+This template implements continuous delivery/continuous deployment for projects hosted on Docker Compose.
+
+It allows you to manage automatic deployment & cleanup of standard predefined environments.
+Each environment can be enabled/disabled by configuration.
+If you're not satisfied with predefined environments and/or their associated Git workflow, you may implement you own environments and
+workflow, by reusing/extending the base (hidden) jobs. This is advanced usage and will not be covered by this documentation.
+
+The following chapters present the managed predefined environments and their associated Git workflow.
+
+#### Review environments
+
+The template supports **review** environments: those are dynamic and ephemeral environments to deploy your
+_ongoing developments_ (a.k.a. _feature_ or _topic_ branches).
+
+When enabled, it deploys the result from upstream build stages to a dedicated and temporary environment.
+It is only active for non-production, non-integration branches.
+
+It is a strict equivalent of GitLab's [Review Apps](https://docs.gitlab.com/ee/ci/review_apps/) feature.
+
+It also comes with a _cleanup_ job (accessible either from the _environments_ page, or from the pipeline view).
+
+#### Integration environment
+
+If you're using a Git Workflow with an integration branch (such as [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)),
+the template supports an **integration** environment.
+
+When enabled, it deploys the result from upstream build stages to a dedicated environment.
+It is only active for your integration branch (`develop` by default).
+
+#### Production environments
+
+Lastly, the template supports 2 environments associated to your production branch (`master` or `main` by default):
+
+* a **staging** environment (an iso-prod environment meant for testing and validation purpose),
+* the **production** environment.
+
+You're free to enable whichever or both, and you can also choose your deployment-to-production policy:
+
+* **continuous deployment**: automatic deployment to production (when the upstream pipeline is successful),
+* **continuous delivery**: deployment to production can be triggered manually (when the upstream pipeline is successful).
+
+### Supported authentication methods
+
+The Docker Compose template supports the following authentication methods:
+
+* TODO (document)
+
+### Deployment context variables
+
+In order to manage the various deployment environments, this template provides a couple of **dynamic variables**
+that you might use in your hook scripts, deployment manifests and other deployment resources:
+
+* `${environment_type}`: the current deployment environment type (`review`, `integration`, `staging` or `production`)
+* `${environment_name}`: a generated application name to use for the current deployment environment (ex: `myapp-review-fix-bug-12` or `myapp-staging`) - _details below_
+
+#### Generated environment name
+
+The `${environment_name}` variable is generated to designate each deployment environment with a unique and meaningful application name.
+By construction, it is suitable for inclusion in DNS, URLs, Kubernetes labels...
+It is built from:
+
+* the application _base name_ (defaults to `$CI_PROJECT_NAME` but can be overridden globally and/or per deployment environment - _see configuration variables_)
+* GitLab predefined `$CI_ENVIRONMENT_SLUG` variable ([sluggified](https://en.wikipedia.org/wiki/Clean_URL#Slug) name, truncated to 24 characters)
+
+The `${environment_name}` variable is then evaluated as:
+
+* `<app base name>` for the production environment
+* `<app base name>-$CI_ENVIRONMENT_SLUG` for all other deployment environments
+* :bulb: `${environment_name}` can also be overriden per environment with the appropriate configuration variable
+
+Examples (with an application's base name `myapp`):
+
+| `$environment_type` | Branch        | `$CI_ENVIRONMENT_SLUG`  | `$environment_name` |
+|---------------------|---------------|-------------------------|---------------------|
+| `review`            | `feat/blabla` | `review-feat-bla-xmuzs6`| `myapp-review-feat-bla-xmuzs6` |
+| `integration`       | `develop`     | `integration`           | `myapp-integration` |
+| `staging`           | `main`        | `staging`               | `myapp-staging` |
+| `production`        | `main`        | `production`            | `myapp` |
+
+### Deployment and cleanup
+
+> TODO: explain here the supported techniques to deploy and cleanup the environments.
+>
+> You should also explained clearly what is expected from the template user and what is the lookup policy in case the template
+> implements one.
+>
+> Example:
+
+The Docker Compose template requires you to provide a shell script that fully implements your application
+deployment and cleanup using the `docker-compose` CLI and all other tools available in the selected Docker image.
+
+The deployment script is searched as follows:
+
+1. look for a specific `dcmp-deploy-$environment_type.sh` in the `$DCMP_SCRIPTS_DIR` directory in your project (e.g. `dcmp-deploy-staging.sh` for staging environment),
+2. if not found: look for a default `dcmp-deploy.sh` in the `$DCMP_SCRIPTS_DIR` directory in your project,
+3. if not found: the deployment job will fail.
+
+The cleanup script is searched as follows:
+
+1. look for a specific `dcmp-cleanup-$environment_type.sh` in the `$DCMP_SCRIPTS_DIR` directory in your project (e.g. `dcmp-cleanup-staging.sh` for staging environment),
+2. if not found: look for a default `dcmp-cleanup.sh` in the `$DCMP_SCRIPTS_DIR` directory in your project,
+3. if not found: the cleanup job will fail.
+
+> :information_source: Your deployment (and cleanup) scripts have to be able to cope with various environments, each with different application names, exposed routes, settings, ...
+> Part of this complexity can be handled by the lookup policies described above (ex: one script per env) and also by using available environment variables:
+>
+> 1. [deployment context variables](#deployment-context-variables) provided by the template:
+>     * `${environment_type}`: the current environment type (`review`, `integration`, `staging` or `production`)
+>     * `${environment_name}`: the application name to use for the current environment (ex: `myproject-review-fix-bug-12` or `myproject-staging`)
+>     * `${hostname}`: the environment hostname, extracted from the current environment url (after late variable expansion - see below)
+> 2. any [GitLab CI variable](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)
+> 3. any [custom variable](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project)
+>     (ex: `${SECRET_TOKEN}` that you have set in your project CI/CD variables)
+
+### Environments URL management
+
+The Docker Compose template supports two ways of providing your environments url:
+
+* a **static way**: when the environments url can be determined in advance, probably because you're exposing your routes through a DNS you manage,
+* a [**dynamic way**](https://docs.gitlab.com/ee/ci/environments/#set-dynamic-environment-urls-after-a-job-finishes): when the url cannot be known before the
+  deployment job is executed.
+
+The **static way** can be implemented simply by setting the appropriate configuration variable(s) depending on the environment (see environments configuration chapters):
+
+* `$DCMP_ENVIRONMENT_URL` to define a default url pattern for all your envs,
+* `$DCMP_REVIEW_ENVIRONMENT_URL`, `$DCMP_INTEG_ENVIRONMENT_URL`, `$DCMP_STAGING_ENVIRONMENT_URL` and `$DCMP_PROD_ENVIRONMENT_URL` to override the default.
+
+> :information_source: Each of those variables support a **late variable expansion mechanism** with the `%{somevar}` syntax, 
+> allowing you to use any dynamically evaluated variables such as `${environment_name}`.
+>
+> Example:
+>
+> ```yaml
+> variables:
+>   DCMP_BASE_APP_NAME: "wonderapp"
+>   # global url for all environments
+>   DCMP_ENVIRONMENT_URL: "https://%{environment_name}.nonprod.acme.domain"
+>   # override for prod (late expansion of $DCMP_BASE_APP_NAME not needed here)
+>   DCMP_PROD_ENVIRONMENT_URL: "https://$DCMP_BASE_APP_NAME.acme.domain"
+>   # override for review (using separate resource paths)
+>   DCMP_REVIEW_ENVIRONMENT_URL: "https://wonderapp-review.nonprod.acme.domain/%{environment_name}"
+> ```
+
+To implement the **dynamic way**, your deployment script shall simply generate a `environment_url.txt` file in the working directory, containing only
+the dynamically generated url. When detected by the template, it will use it as the newly deployed environment url.
+
+### Deployment output variables
+
+Each deployment job produces _output variables_ that are propagated to downstream jobs (using [dotenv artifacts](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html#artifactsreportsdotenv)):
+
+* `$environment_type`: set to the type of environment (`review`, `integration`, `staging` or `production`),
+* `$environment_name`: the application name (see below),
+* `$environment_url`: set to the environment URL (whether determined statically or dynamically).
+
+Those variables may be freely used in downstream jobs (for instance to run acceptance tests against the latest deployed environment).
+
+You may also add and propagate your own custom variables, by pushing them to the `docker-compose.env` file in your [deployment scripts or hooks](#deployment-and-cleanup).
+
+## Configuration reference
+
+### Secrets management
+
+Here are some advices about your **secrets** (variables marked with a :lock:): 
+
+1. Manage them as [project or group CI/CD variables](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project):
+    * [**masked**](https://docs.gitlab.com/ee/ci/variables/#mask-a-cicd-variable) to prevent them from being inadvertently 
+      displayed in your job logs,
+    * [**protected**](https://docs.gitlab.com/ee/ci/variables/#protected-cicd-variables) if you want to secure some secrets 
+      you don't want everyone in the project to have access to (for instance production secrets).
+2. In case a secret contains [characters that prevent it from being masked](https://docs.gitlab.com/ee/ci/variables/#mask-a-cicd-variable), 
+  simply define its value as the [Base64](https://en.wikipedia.org/wiki/Base64) encoded value prefixed with `@b64@`: 
+  it will then be possible to mask it and the template will automatically decode it prior to using it.
+3. Don't forget to escape special characters (ex: `$` -> `$$`).
+
+### Global configuration
+
+The Docker Compose template uses some global configuration used throughout all jobs and environments.
+
+| Input / Variable         | Description                            | Default value     |
+| ------------------------ | -------------------------------------- | ----------------- |
+| `image` / `DCMP_IMAGE`              | the Docker image used to run Docker Compose CLI commands | `registry.hub.docker.com/docker-compose:latest` |
+| `base-app-name` / `DCMP_BASE_APP_NAME`      | Base application name                  | `$CI_PROJECT_NAME` ([see GitLab doc](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)) |
+| `api-url` / `DCMP_API_URL`            | Default Docker Compose API url | _none_ |
+| :lock: `DCMP_API_TOKEN`          | Default Docker Compose API token | _none_ |
+| `environment-url` / `DCMP_ENVIRONMENT_URL`    | Default environments url _(only define for static environment URLs declaration)_<br/>_supports late variable expansion (ex: `https://%{environment_name}.docker-compose.acme.com`)_ | _none_ |
+| `scripts-dir` / `DCMP_SCRIPTS_DIR`        | Directory where deploy & cleanup scripts are located | `.` _(root project dir)_ |
+
+### Review environments configuration
+
+Review environments are dynamic and ephemeral environments to deploy your _ongoing developments_ (a.k.a. _feature_ or 
+_topic_ branches).
+
+They are **disabled by default** and can be enabled by setting the `DCMP_REVIEW_PROJECT` variable (see below).
+
+Here are variables supported to configure review environments:
+
+| Input / Variable         | Description                            | Default value     |
+| ------------------------ | -------------------------------------- | ----------------- |
+| `review-project` / `DCMP_REVIEW_PROJECT`     | Project ID for `review` env | _none_ (disabled) |
+| `review-app-name` / `DCMP_REVIEW_APP_NAME`    | Application name for `review` env      | `"${DCMP_BASE_APP_NAME}-${CI_ENVIRONMENT_SLUG}"` (ex: `myproject-review-fix-bug-12`) |
+| `review-api-url` / `DCMP_REVIEW_API_URL`     | API url for `review` env _(only define to override default)_ | `$DCMP_API_URL` |
+| :lock: `DCMP_REVIEW_API_TOKEN`   | API token for `review` env _(only define to override default)_ | `$DCMP_API_TOKEN` |
+| `review-environment-url` / `DCMP_REVIEW_ENVIRONMENT_URL`| The review environments url _(only define for static environment URLs declaration and if different from default)_ | `$DCMP_ENVIRONMENT_URL` |
+| `review-autostop-duration` / `DCMP_REVIEW_AUTOSTOP_DURATION`| The amount of time before GitLab will automatically stop `review` environments | `4 hours` |
+
+### Integration environment configuration
+
+The integration environment is the environment associated to your integration branch (`develop` by default).
+
+It is **disabled by default** and can be enabled by setting the `DCMP_INTEG_PROJECT` variable (see below).
+
+Here are variables supported to configure the integration environment:
+
+| Input / Variable         | Description                            | Default value     |
+| ------------------------ | -------------------------------------- | ----------------- |
+| `integ-project` / `DCMP_INTEG_PROJECT`      | Project ID for `integration` env | _none_ (disabled) |
+| `integ-app-name` / `DCMP_INTEG_APP_NAME`     | Application name for `integration` env | `${DCMP_BASE_APP_NAME}-integration` |
+| `integ-api-url` / `DCMP_INTEG_API_URL`      | API url for `integration` env _(only define to override default)_ | `$DCMP_API_URL` |
+| :lock: `DCMP_INTEG_API_TOKEN`    | API token for `integration` env _(only define to override default)_ | `$DCMP_API_TOKEN` |
+| `integ-environment-url` / `DCMP_INTEG_ENVIRONMENT_URL`| The integration environment url _(only define for static environment URLs declaration and if different from default)_ | `$DCMP_ENVIRONMENT_URL` |
+
+### Staging environment configuration
+
+The staging environment is an iso-prod environment meant for testing and validation purpose associated to your production 
+branch (`main` or `master` by default).
+
+It is **disabled by default** and can be enabled by setting the `DCMP_STAGING_PROJECT` variable (see below).
+
+Here are variables supported to configure the staging environment:
+
+| Input / Variable         | Description                            | Default value     |
+| ------------------------ | -------------------------------------- | ----------------- |
+| `staging-project` / `DCMP_STAGING_PROJECT`    | Project ID for `staging` env | _none_ (disabled) |
+| `staging-app-name` / `DCMP_STAGING_APP_NAME`   | Application name for `staging` env     | `${DCMP_BASE_APP_NAME}-staging` |
+| `staging-api-url` / `DCMP_STAGING_API_URL`    | API url for `staging` env _(only define to override default)_ | `$DCMP_API_URL` |
+| :lock: `DCMP_STAGING_API_TOKEN`  | API token for `staging` env _(only define to override default)_ | `$DCMP_API_TOKEN` |
+| `staging-environment-url` / `DCMP_STAGING_ENVIRONMENT_URL`| The staging environment url _(only define for static environment URLs declaration and if different from default)_ | `$DCMP_ENVIRONMENT_URL` |
+
+### Production environment configuration
+
+The production environment is the final deployment environment associated with your production branch (`main` or `master` by default).
+
+It is **disabled by default** and can be enabled by setting the `DCMP_PROD_PROJECT` variable (see below).
+
+Here are variables supported to configure the production environment:
+
+| Input / Variable          | Description                            | Default value     |
+| ------------------------- | -------------------------------------- | ----------------- |
+| `prod-project` / `DCMP_PROD_PROJECT`        | Project ID for `production` env | _none_ (disabled) |
+| `prod-app-name` / `DCMP_PROD_APP_NAME`       | Application name for `production` env  | `$DCMP_BASE_APP_NAME` |
+| `prod-api-url` / `DCMP_PROD_API_URL`        | API url for `production` env _(only define to override default)_ | `$DCMP_API_URL` |
+| :lock: `DCMP_PROD_API_TOKEN`      | API token for `production` env _(only define to override default)_ | `$DCMP_API_TOKEN` |
+| `prod-environment-url` / `DCMP_PROD_ENVIRONMENT_URL`| The production environment url _(only define for static environment URLs declaration and if different from default)_ | `$DCMP_ENVIRONMENT_URL` |
+| `prod-deploy-strategy` / `DCMP_PROD_DEPLOY_STRATEGY`| Defines the deployment to production strategy. One of `manual` (i.e. _one-click_) or `auto`. | `manual` |

SECURITY.md

+# Security Policy
+
+## Supported Versions
+
+Security fixes and updates are only applied to the latest released version. So always try to be up to date.
+
+## Reporting a Vulnerability
+
+In order to minimize risks of attack while investigating and fixing the issue, any vulnerability shall be reported by 
+opening a [**confidential** issue on gitlab.com](https://gitlab.com/to-be-continuous/docker-compose/-/issues/new?issue[confidential]=true&issue[description]=%28type+in+the+vulnerability+details+here%29%0A%0A%2Flabel%20~%22kind%3A%3Avulnerability%22).
+
+Follow-up and fixing will be made on a _best effort_ basis.
+
+If you have doubts about a potential vulnerability, please reach out one of the maintainers on Discord.

bumpversion.sh

+#!/usr/bin/env bash
+
+function log_info() {
+  >&2 echo -e "[\\e[1;94mINFO\\e[0m] $*"
+}
+
+function log_warn() {
+  >&2 echo -e "[\\e[1;93mWARN\\e[0m] $*"
+}
+
+function log_error() {
+  >&2 echo -e "[\\e[1;91mERROR\\e[0m] $*"
+}
+
+# check number of arguments
+if [[ "$#" -le 2 ]]; then
+  log_error "Missing arguments"
+  log_error "Usage: $0 <current version> <next version>"
+  exit 1
+fi
+
+curVer=$1
+nextVer=$2
+relType=$3
+
+if [[ "$curVer" ]]; then
+  log_info "Bump version from \\e[33;1m${curVer}\\e[0m to \\e[33;1m${nextVer}\\e[0m (release type: $relType)..."
+
+  # replace in README
+  sed -e "s/ref: *'$curVer'/ref: '$nextVer'/" -e "s/ref: *\"$curVer\”/ref: \”$nextVer\”/" -e "s/component: *\(.*\)@$curVer/component: \1@$nextVer/" README.md > README.md.next
+  mv -f README.md.next README.md
+
+  # replace in template and variants
+  for tmpl in templates/*.yml
+  do
+    sed -e "s/command: *\[\"--service\", \"\(.*\)\", \"$curVer\"\]/command: [\"--service\", \"\1\", \"$nextVer\"]/" "$tmpl" > "$tmpl.next"
+    mv -f "$tmpl.next" "$tmpl"
+  done
+else
+  log_info "Bump version to \\e[33;1m${nextVer}\\e[0m (release type: $relType): this is the first release (skip)..."
+fi

kicker.json

+
+{
+  "name": "Docker Compose",
+  "description": "Deploy your application with [Docker Compose](https://docs.docker.com/compose/)",
+  "template_path": "templates/gitlab-ci-docker-compose.yml",
+  "kind": "hosting",
+  "prefix": "dcmp",
+  "is_component": true,
+  "variables": [
+    {
+      "name": "DCMP_IMAGE",
+      "description": "The Docker image used to run Docker Compose CLI commands - **set the version required by your Docker Compose cluster**",
+      "default": "registry.hub.docker.com/docker-compose:latest"
+    },
+    {
+      "name": "DCMP_API_URL",
+      "type": "url",
+      "description": "Default Docker Compose API url"
+    },
+    {
+      "name": "DCMP_API_TOKEN",
+      "description": "Default Docker Compose API token",
+      "secret": true
+    },
+    {
+      "name": "DCMP_BASE_APP_NAME",
+      "description": "Base application name",
+      "default": "$CI_PROJECT_NAME",
+      "advanced": true
+    },
+    {
+      "name": "DCMP_ENVIRONMENT_URL",
+      "type": "url",
+      "description": "The default environments url _(only define for static environment URLs declaration)_\n\n_supports late variable expansion (ex: `https://%{environment_name}.dcmp.acme.com`)_"
+    },
+    {
+      "name": "DCMP_SCRIPTS_DIR",
+      "description": "Directory where deploy & cleanup scripts are located",
+      "default": ".",
+      "advanced": true
+    }
+  ],
+  "features": [
+    {
+      "id": "review",
+      "name": "Review",
+      "description": "Dynamic review environments for your topic branches (see GitLab [Review Apps](https://docs.gitlab.com/ee/ci/review_apps/))",
+      "variables": [
+        {
+          "name": "DCMP_REVIEW_PROJECT",
+          "description": "Project ID for `review` env",
+          "mandatory": true
+        },
+        {
+          "name": "DCMP_REVIEW_APP_NAME",
+          "description": "The application name for `review` env (only define to override default)",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_REVIEW_AUTOSTOP_DURATION",
+          "description": "The amount of time before GitLab will automatically stop `review` environments",
+          "default": "4 hours"
+        },
+        {
+          "name": "DCMP_REVIEW_ENVIRONMENT_URL",
+          "type": "url",
+          "description": "The `review` environments url _(only define for static environment URLs declaration and if different from default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_REVIEW_API_URL",
+          "type": "url",
+          "description": "API url for `review` env _(only define to override default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_REVIEW_API_TOKEN",
+          "description": "API token for `review` env (only define to override default)",
+          "secret": true
+        }
+      ]
+    },
+    {
+      "id": "integration",
+      "name": "Integration",
+      "description": "A continuous-integration environment associated to your integration branch (`develop` by default)",
+      "variables": [
+        {
+          "name": "DCMP_INTEG_PROJECT",
+          "description": "Project ID for `integration` env",
+          "mandatory": true
+        },
+        {
+          "name": "DCMP_INTEG_APP_NAME",
+          "description": "The application name for `integration` env (only define to override default)",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_INTEG_ENVIRONMENT_URL",
+          "type": "url",
+          "description": "The `integration` environment url _(only define for static environment URLs declaration and if different from default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_INTEG_API_URL",
+          "type": "url",
+          "description": "API url for `integration` env _(only define to override default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_INTEG_API_TOKEN",
+          "description": "API token for `integration` env (only define to override default)",
+          "secret": true
+        }
+      ]
+    },
+    {
+      "id": "staging",
+      "name": "Staging",
+      "description": "An iso-prod environment meant for testing and validation purpose on your production branch (`main` or `master` by default)",
+      "variables": [
+        {
+          "name": "DCMP_STAGING_PROJECT",
+          "description": "Project ID for `staging` env",
+          "mandatory": true
+        },
+        {
+          "name": "DCMP_STAGING_APP_NAME",
+          "description": "The application name for `staging` env (only define to override default)",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_STAGING_ENVIRONMENT_URL",
+          "type": "url",
+          "description": "The `staging` environment url _(only define for static environment URLs declaration and if different from default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_STAGING_API_URL",
+          "type": "url",
+          "description": "API url for `staging` env _(only define to override default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_STAGING_API_TOKEN",
+          "description": "API token for `staging` env (only define to override default)",
+          "secret": true
+        }
+      ]
+    },
+    {
+      "id": "prod",
+      "name": "Production",
+      "description": "The production environment",
+      "variables": [
+        {
+          "name": "DCMP_PROD_PROJECT",
+          "description": "Project ID for `production` env",
+          "mandatory": true
+        },
+        {
+          "name": "DCMP_PROD_APP_NAME",
+          "description": "The application name for `production` env (only define to override default)",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_PROD_ENVIRONMENT_URL",
+          "type": "url",
+          "description": "The `production` environment url _(only define for static environment URLs declaration and if different from default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_PROD_DEPLOY_STRATEGY",
+          "description": "Defines the deployment to `production` strategy.",
+          "type": "enum",
+          "values": ["manual", "auto"],
+          "default": "manual"
+        },
+        {
+          "name": "DCMP_PROD_API_URL",
+          "type": "url",
+          "description": "API url for `production` env _(only define to override default)_",
+          "advanced": true
+        },
+        {
+          "name": "DCMP_PROD_API_TOKEN",
+          "description": "API token for `production` env (only define to override default)",
+          "secret": true
+        }
+      ]
+    }
+  ]
+}

post-release.sh

+#!/usr/bin/env bash
+
+function log_info() {
+  >&2 echo -e "[\\e[1;94mINFO\\e[0m] $*"
+}
+
+function log_warn() {
+  >&2 echo -e "[\\e[1;93mWARN\\e[0m] $*"
+}
+
+function log_error() {
+  >&2 echo -e "[\\e[1;91mERROR\\e[0m] $*"
+}
+
+# check number of arguments
+if [[ "$#" -lt 1 ]]; then
+  log_error "Missing arguments"
+  log_error "Usage: $0 <next version>"
+  exit 1
+fi
+
+nextVer=$1
+minorVer=${nextVer%\.[0-9]*}
+majorVer=${nextVer%\.[0-9]*\.[0-9]*}
+
+log_info "Creating minor version tag alias \\e[33;1m${minorVer}\\e[0m from $nextVer..."
+git tag --force -a "$minorVer" "$nextVer" -m "Minor version alias (targets $nextVer)"
+
+log_info "Creating major version tag alias \\e[33;1m${majorVer}\\e[0m from $nextVer..."
+git tag --force -a "$majorVer" "$nextVer" -m "Major version alias (targets $nextVer)"
+
+log_info "Pushing tags..."
+git_base_url=$(echo "$CI_REPOSITORY_URL" | cut -d\@ -f2)
+git_auth_url="https://token:${GITLAB_TOKEN}@${git_base_url}"
+git push --tags --force "$git_auth_url"