diff --git a/README.md b/README.md index cfe75a2860050b9d5b615b4457f1497c387f74f8..7738c212117398d8e53078fa2f8cf4131d69cb72 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,13 @@ include: The Python template uses some global configuration used throughout all jobs. -| Name | description | default value | -| -------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------ | -| `PYTHON_IMAGE` | The Docker image used to run Python. **It is highly recommended to set the specific version your project needs** | `python:3` | -| `PIP_INDEX_URL` | Python repository url | _none_ | -| `PYTHON_PROJECT_DIR` | Python project root directory | `.` | -| `REQUIREMENTS_FILE` | Path to requirements file _(relative to `$PYTHON_PROJECT_DIR`)_ | `requirements.txt` | -| `PIP_OPTS` | pip extra [options](https://pip.pypa.io/en/stable/reference/pip/#general-options) | _none_ | +| Name | description | default value | +| -------------------- | ------------------------------------------------------------------------------------- | ------------------ | +| `PYTHON_IMAGE` | The Docker image used to run Python <br/>:warning: **set the version required by your project** | `python:3` | +| `PIP_INDEX_URL` | Python repository url | _none_ | +| `PYTHON_PROJECT_DIR` | Python project root directory | `.` | +| `REQUIREMENTS_FILE` | Path to requirements file _(relative to `$PYTHON_PROJECT_DIR`)_ | `requirements.txt` | +| `PIP_OPTS` | pip extra [options](https://pip.pypa.io/en/stable/reference/pip/#general-options) | _none_ | The cache policy also declares the `.cache/pip` directory as cached (not to download Python dependencies over and over again). @@ -281,6 +281,6 @@ It is bound to the `publish` stage, applies only on tags and uses the following | `DOCS_BUILD_DIR` | Output build directory for documentation | `public` | | `DOCS_MAKE_ARGS` | Args of make command | `html BUILDDIR=${DOCS_BUILD_DIR}` | -## Gitlab compatibility +## GitLab compatibility :information_source: This template is actually tested and validated on GitLab Community Edition instance version 13.12.11 diff --git a/kicker.json b/kicker.json index efffb3e8cbb401c1871af7307f6ae664a3498676..33ebec6ba992ddefcbb13c946755a35c529930be 100644 --- a/kicker.json +++ b/kicker.json @@ -6,7 +6,7 @@ "variables": [ { "name": "PYTHON_IMAGE", - "description": "The Docker image used to run Python - **it is highly recommended to set the specific version your project needs**", + "description": "The Docker image used to run Python - **set the version required by your project**", "default": "python:3" }, {