# gcil
<!-- markdownlint-disable no-inline-html -->
[](https://pypi.org/project/gitlabci-local)
[](https://pypi.org/project/gitlabci-local)
[](https://pypi.org/project/gitlabci-local)
[](https://gitlab.com/RadianDevCore/tools/gcil/-/blob/main/LICENSE)
<br />
[](https://gitlab.com/RadianDevCore/tools/gcil/-/commits/main/)
[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)
[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)
[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)
[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)
[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)
<br />
[](https://github.com/pre-commit/pre-commit)
[](https://commitizen-tools.github.io/commitizen/)
[](https://radiandevcore.gitlab.io/tools/gcil)
[](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)
Launch .gitlab-ci.yml jobs locally, wrapped inside the specific images,
with inplace project volume mounts and adaptive user selections.
**Documentation:** <https://radiandevcore.gitlab.io/tools/gcil>
**Package:** <https://pypi.org/project/gitlabci-local/>
---
## Purpose
The main purpose of this project is to unify and enhance reliability
of builds, tests or releases running on GitLab CI in a similar local context,
by providing the simplicity of an interactive and automated terminal tool
and avoiding code duplication (Makefile, Shell scripts, docker run, ...).
Rather than creating yet another standard, the .gitlab-ci.yml specification
is the common and unique interface between GitLab CI and `gcil`.
---
## Preview
---
<span class="page-break"></span>
## Examples
<!-- prettier-ignore-start -->
```bash
gcil # Launch the jobs choices interactive menu
gcil -p # Launch the jobs pipeline automatically
gcil -l # Launch the job selection interactive menu
gcil 'Dev' # Launch jobs where the name contains a given string
gcil 'Job 1' --debug # Hold a finishing specific job for debugging
gcil 'Job 1' --bash # Prepare a bash environment for a specific job
gitlabci-local # Shortcut alias to gcil
```
<!-- prettier-ignore-end -->
---
## Usage
<!-- prettier-ignore-start -->
<!-- readme-help-start -->
```yaml
usage: gcil [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL] [-p] [-q]
[-c CONFIGURATION] [-B] [-A] [-C COMMANDS] [-n NETWORK] [-e ENV] [-E ENGINE] [-H] [--notify] [-r] [-S]
[--ssh [SSH_USER]] [-v VOLUME] [-w WORKDIR] [--bash | --debug] [--display] [--shell SHELL] [--all]
[--defaults] [-f] [-i] [-m] [--no-console] [--no-git-safeties] [--no-script-fail] [-R] [--no-verbose]
[--scripts] [-t TAGS] [-d | -s | -l | --pull | --rmi] [--]
[names ...]
gcil: Launch .gitlab-ci.yml jobs locally (aliases: gitlabci-local)
internal arguments:
-h, --help # Show this help message
--version # Show the current version
--no-color # Disable colors outputs with 'NO_COLOR=1'
# (or default settings: [themes] > no_color)
--update-check # Check for newer package updates
--settings # Show the current settings path and contents
--set GROUP KEY VAL # Set settings specific 'VAL' value to [GROUP] > KEY
# or unset by using 'UNSET' as 'VAL'
pipeline arguments:
-p, --pipeline # Automatically run pipeline stages rather than jobs
-q, --quiet # Hide jobs execution context
-c CONFIGURATION # Path to the .gitlab-ci.yml configuration file or folder
-B, --no-before # Disable before_script executions
-A, --no-after # Disable after_script executions
-C COMMANDS # Run specific commands instead of "scripts" commands
-n NETWORK # Configure the network mode used (or define CI_LOCAL_NETWORK)
# Choices: bridge, host, none. Default: bridge
-e ENV # Define VARIABLE=value, pass VARIABLE or ENV file
-E ENGINE # Force a specific engine (or define CI_LOCAL_ENGINE)
# Default list: auto,docker,podman
-H, --host # Run all jobs on the host rather than containers
--notify # Enable host notifications of pipeline and jobs results
-r, --real-paths # Mount real folder paths in the container (Linux / macOS only)
-S, --sockets # Mount engine sockets for nested containers
# (Enabled by default with services: docker:*dind)
--ssh [SSH_USER] # Bind SSH credentials to a container's user
-v VOLUME # Mount VOLUME or HOST:TARGET in containers
-w WORKDIR # Override the container's working path
debugging arguments:
--bash # Prepare runners for manual bash purposes
--debug # Keep runners active for debugging purposes
--display # Enable host DISPLAY forwarding features
--shell SHELL # Configure the default bash/debug shell entrypoint
jobs arguments:
--all # Enable all jobs by default in selections
--defaults # Use default variables for .local:configurations
-f, --force # Force the action (use with --pull)
-i, --ignore-case # Ignore case when searching for names
-m, --manual # Allow manual jobs to be used
--no-console # Disable console launch in bash/debug modes
# (or default settings: [runner] > no_console)
--no-git-safeties # Disable automated Git safeties configuration
# (or default settings: [runner] > no_git_safeties)
--no-script-fail # Fail on missing 'script' nodes of jobs
# (or default settings: [runner] > no_script_fail)
-R, --no-regex # Disable regex search of names
--no-verbose # Hide jobs verbose outputs
--scripts # Dump parsed jobs entrypoint scripts
-t TAGS # Handle listed tags as manual jobs
# Default list: deploy,local,publish
features arguments:
-d, --dump # Dump parsed .gitlab-ci.yml configuration
-s, --select # Force jobs selection from enumerated names
-l, --list # Select one job to run (implies --manual)
--pull # Pull container images from all jobs
--rmi # Delete container images from all jobs
positional arguments:
-- # Positional arguments separator (recommended)
names # Names of specific jobs (or stages with --pipeline)
# Regex names is supported unless --no-regex is used
```
<!-- readme-help-stop -->
<!-- prettier-ignore-end -->
---
<span class="page-break"></span>
## User configurations with '.local:configurations'
`gcil` implements support for specific user configurations
allowing simple and interactive local pipeline configurations.
Supported user configurations include `boolean`, `choice`, `input`, `yaml` and `json`.
Examples for each of these can be found in the `configurations` unit tests: [tests/configurations](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/tests/configurations/.gitlab-ci.yml)
---
<span class="page-break"></span>
## Additional features in 'variables'
`gcil` implements further support of most command-line parameters
using `variables:` values, either globally or specifically for each job:
<!-- prettier-ignore-start -->
```yaml
variables:
CI_LOCAL_NETWORK: 'str' # Configure the network mode used (see `--network`)
```
<!-- prettier-ignore-end -->
## Additional features in '.local'
`gcil` implements further support of most command-line parameters
inside a `.local:` node to ease default parameters definitions.
Supported local values for a `.local` node are:
<!-- prettier-ignore-start -->
```yaml
.local:
after: bool # Enable or disable `after_script` executions (see `-A`)
all: bool # Enable all jobs by default in selections (see `--all`)
bash: bool # Prepare runners for manual bash purposes (see `--bash`)
before: bool # Enable or disable `before_script` executions (see `-B`)
configurations: dict # See [User configurations with '.local:configurations'](#user-configurations-with-localconfigurations)
debug: bool # Keep runners active for debugging purposes (see `--debug`)
defaults: bool # Use default variables for `.local:configurations` (see `--defaults`)
display: bool # Enable host `DISPLAY` forwarding features (see `--display`)
engine: str # Force a specific engine (see `-E`)
env: list[str] # Define `VARIABLE=value`, pass `VARIABLE` or `ENV` file (see `-e`)
image: dict|str # Override container image's `name` and/or `entrypoint
include: dict # Map `include: project:` names to local paths
manual: bool # Allow manual jobs to be used (see `--manual`)
names: list[str] # Names of specific jobs (or stages with `--pipeline`) (see `names`)
no_console: bool # Disable console launch in bash/debug modes (see `--no-console`)
no_regex: bool # Disable regex search of names (see `--no-regex`)
no_verbose: bool # Hide jobs verbose outputs (see `--no-verbose`)
notify: bool # Enable host notifications of pipeline and jobs results (see `--notify`)
pipeline: bool # Automatically run pipeline stages rather than jobs (see `-p`)
quiet: bool # Hide jobs execution context (see `-q`)
real_paths: bool # Mount real folder paths in the container (see `-r`)
shell: str # Configure the default bash/debug shell entrypoint (see `--shell`)
sockets: bool # Mount engine sockets for nested containers (see `-S`)
ssh: bool|str # Bind SSH credentials to a container's user (see `--ssh`)
tags: list[str] # Handle listed tags as manual jobs (see `--tags`)
variables: dict[str] # Define `KEY: VALUE` variables for local jobs
version: str # Define a minimum version for `gcil` recommended for this file
volumes: bool # Mount `VOLUME` or `HOST:TARGET` in containers (see `-v`)
workdir: bool # Override the container's working path (see `-w`)
```
<!-- prettier-ignore-end -->
Examples for each of these can be found in the `local` unit tests: [tests/local](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/tests/local/.gitlab-ci.yml)
and [tests/includes](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/tests/includes/.gitlab-ci.project.yml)
---
<span class="page-break"></span>
## Job execution in native context
`gcil` runs every jobs in the specified container image.
For specific local purposes where the native host context is wished,
where the host tools, folders or credentials are required,
`image: local` can be used to run the scripts natively.
For specific purposes, the `image: local:quiet` variant
can be used to enable the `quiet` option for specific jobs.
The `image: local:silent` variant extends the `quiet` option
by also disabling the verbose script `set -x` line entry.
An example usage can be found in the local `Changelog` job: [.gitlab-ci.yml](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/.gitlab-ci.yml)
---
<span class="page-break"></span>
## Environment variables
<details>
<summary>Expand environment variables documentation</summary>
<div style="padding-left: 30px">
<br />
`gcil` uses the variables defined in .gitlab-ci.yml,
parses the simple environment variables file named `.env`
and the configurations selected through `.local:configurations`.
If specific environment variables are to be used in the job's container:
- `-e VARIABLE`: pass an environment variable
- `-e VARIABLE=value`: set a variable to a specific value
- `-e ENVIRONMENT_FILE`: parse a file as default variables
For example, `-e TERM=ansi` may enable colored terminal outputs.
The variable `CI_LOCAL` is automatically defined to `true` by `gcil`
to allow specific conditions for local purposes in jobs' scripts.
The variable `CI_LOCAL_HOST` is automatically defined to `true` by `gcil`
if running the job natively on the host (for example wiht `--host`)
The following variables are also defined by `gcil`:
- `CI_COMMIT_REF_NAME`: The branch or tag name for which project is built (GitLab CI)
- `CI_COMMIT_REF_SLUG`: CI_COMMIT_REF_NAME in lowercase, shortened to 63 bytes,
and with everything except 0-9 and a-z replaced with -. No leading / trailing - (GitLab CI)
- `CI_COMMIT_SHA`: The commit revision for which project is built (GitLab CI)
- `CI_COMMIT_SHORT_SHA`: The first eight characters of CI_COMMIT_SHA (GitLab CI)
- `CI_PROJECT_NAME`: The name of the directory for the project (GitLab CI)
- `CI_PROJECT_NAMESPACE`: The project namespace (username or group name) of the job (GitLab CI)
- `CI_LOCAL_USER_HOST_GID`: The host user's group ID value
- `CI_LOCAL_USER_HOST_UID`: The host user's user ID value
- `CI_LOCAL_USER_HOST_USERNAME`: The host user's username value
</div>
</details>
---
<span class="page-break"></span>
## Supported container engines
`gcil` currently supports these container engines:
- **Docker :** <https://docs.docker.com/get-docker/> (root daemon, as user or sudoer)
- **Podman :** <https://podman.io/getting-started/> (rootless or root CLI)
---
## Supported systems
<details>
<summary>Supported Linux systems</summary>
<div style="padding-left: 30px">
| Engines | Linux Mint, Ubuntu | CentOS | Others |
| :-------------------: | :----------------: | :----: | :----: |
| Native (shell) | **✓** | **✓** | **?** |
| Docker (as user) | **✓** | **✓** | **?** |
| Docker (as root) | **✓** | **✓** | **?** |
| Podman (as user) | **~** | **~** | **?** |
| Podman (as root) | **✓** | **✓** | **?** |
</div>
</details>
<details>
<summary>Supported macOS systems</summary>
<div style="padding-left: 30px">
| Engines | macOS (10.14, 10.15, 11.0, ...) |
| :-------------------: | :-----------------------------: |
| Native (shell) | **✓** |
| Docker (as user) | **?** |
</div>
</details>
<span class="page-break"></span>
<details>
<summary>Supported Windows systems</summary>
<div style="padding-left: 30px">
| Engines | Windows 10 (1909, 2004, 20H2) | Others |
| :---------------------: | :---------------------------: | :----: |
| Native (Command Prompt) | **~** | **?** |
| Native (Git Bash) | **✓** | **?** |
| Docker (Hyper‑V) | **✓** | **?** |
| Docker (WSL 2) | **✓** | **?** |
</div>
</details>
<details>
<summary>Supported Android systems</summary>
<div style="padding-left: 30px">
| Engines | Android (7.0, 7.1, 8.0, 8.1, 9.0, 10, 11, ...) |
| :-------------: | :--------------------------------------------: |
| Native (Termux) | **✓** |
</div>
</details>
---
<span class="page-break"></span>
## Compatible projects
Most GitLab CI projects should work with `gcil` without any local-specific changes.
However, if specific configurations like credentials, caches or user rights are needed, the `CI_LOCAL` variable and the `.local:` configurations can be used.
Projects compatible with `gcil` can use this badge to ease things for developers, both as an indicator and a documentation shortcut button :
> [](https://radiandevcore.gitlab.io/tools/gcil)
```markdown title="Badge in Markdown"
[](https://radiandevcore.gitlab.io/tools/gcil)
```
```html title="Badge in HTML"
<a href="https://radiandevcore.gitlab.io/tools/gcil"><img src="https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab" alt="gcil" style="max-width:100%;"></a>
```
---
<span class="page-break"></span>
## Userspace available settings
`gcil` creates a `settings.ini` configuration file in a userspace folder.
For example, it allows to change the default engines priority (`[engines] > engine`),
or to disable the automated updates daily check (`[updates] > enabled`)
The `settings.ini` file location and contents can be shown with the following command:
```bash
gcil --settings
```
---
## Environment available configurations
`gcil` uses `colored` for colors outputs and `questionary` for interactive menus.
If colors of both outputs types do not match the terminal's theme,
an environment variable `NO_COLOR=1` can be defined to disable colors.
---
<span class="page-break"></span>
## Dependencies
- [colored](https://pypi.org/project/colored/): Terminal colors and styles
- [docker](https://pypi.org/project/docker/): Docker Engine API
- [python-dotenv](https://pypi.org/project/python-dotenv/): Support for .env files parsing
- [PyYAML](https://pypi.org/project/PyYAML/): YAML parser and emitter for Python
- [questionary](https://pypi.org/project/questionary/): Interactive terminal user interfaces
- [setuptools](https://pypi.org/project/setuptools/): Build and manage Python packages
- [update-checker](https://pypi.org/project/update-checker/): Check for package updates on PyPI
---
## References
- [.gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/): GitLab CI/CD Pipeline Configuration Reference
- [commitizen](https://pypi.org/project/commitizen/): Simple commit conventions for internet citizens
- [git-cliff](https://github.com/orhun/git-cliff): CHANGELOG generator
- [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab
- [OCI](https://opencontainers.org): Open Container Initiative
- [mkdocs](https://www.mkdocs.org/): Project documentation with Markdown
- [mkdocs-exporter](https://adrienbrignon.github.io/mkdocs-exporter/): Exporter plugin for mkdocs documentation
- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/): Material theme for mkdocs documentation
- [mypy](https://pypi.org/project/mypy/): Optional static typing for Python
- [pexpect-executor](https://radiandevcore.gitlab.io/tools/pexpect-executor): Automate interactive CLI tools actions
- [pre-commit](https://pre-commit.com/): A framework for managing and maintaining pre-commit hooks
- [pre-commit-crocodile](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile): Git hooks intended for developers using pre-commit
- [PyPI](https://pypi.org/): The Python Package Index
- [termtosvg](https://pypi.org/project/termtosvg/): Record terminal sessions as SVG animations
- [Termux](https://termux.com): Linux terminal emulator on Android
- [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI
- [winpty](https://github.com/rprichard/winpty): Windows PTY interface wrapper
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/RadianDevCore/tools/gcil",
"name": "gitlabci-local",
"maintainer": null,
"docs_url": null,
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3",
"maintainer_email": null,
"keywords": "gitlab gitlab-ci local gcil gitlabci-local pipeline",
"author": "Adrian DC",
"author_email": "radian.dc@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/2a/58/722db384e6cd90f5a0192034fabb29b4d287f791472842b930385094cf15/gitlabci_local-11.0.0.tar.gz",
"platform": null,
"description": "# gcil\n\n<!-- markdownlint-disable no-inline-html -->\n\n[](https://pypi.org/project/gitlabci-local)\n[](https://pypi.org/project/gitlabci-local)\n[](https://pypi.org/project/gitlabci-local)\n[](https://gitlab.com/RadianDevCore/tools/gcil/-/blob/main/LICENSE)\n<br />\n[](https://gitlab.com/RadianDevCore/tools/gcil/-/commits/main/)\n[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)\n[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)\n[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)\n[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)\n[](https://sonarcloud.io/dashboard?id=RadianDevCore_gcil)\n<br />\n[](https://github.com/pre-commit/pre-commit)\n[](https://commitizen-tools.github.io/commitizen/)\n[](https://radiandevcore.gitlab.io/tools/gcil)\n[](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile)\n\nLaunch .gitlab-ci.yml jobs locally, wrapped inside the specific images, \nwith inplace project volume mounts and adaptive user selections.\n\n**Documentation:** <https://radiandevcore.gitlab.io/tools/gcil> \n**Package:** <https://pypi.org/project/gitlabci-local/>\n\n---\n\n## Purpose\n\nThe main purpose of this project is to unify and enhance reliability \nof builds, tests or releases running on GitLab CI in a similar local context, \nby providing the simplicity of an interactive and automated terminal tool \nand avoiding code duplication (Makefile, Shell scripts, docker run, ...).\n\nRather than creating yet another standard, the .gitlab-ci.yml specification \nis the common and unique interface between GitLab CI and `gcil`.\n\n---\n\n## Preview\n\n\n\n---\n\n<span class=\"page-break\"></span>\n\n## Examples\n\n<!-- prettier-ignore-start -->\n\n```bash\ngcil # Launch the jobs choices interactive menu\ngcil -p # Launch the jobs pipeline automatically\ngcil -l # Launch the job selection interactive menu\ngcil 'Dev' # Launch jobs where the name contains a given string\ngcil 'Job 1' --debug # Hold a finishing specific job for debugging\ngcil 'Job 1' --bash # Prepare a bash environment for a specific job\ngitlabci-local # Shortcut alias to gcil\n```\n\n<!-- prettier-ignore-end -->\n\n---\n\n## Usage\n\n<!-- prettier-ignore-start -->\n<!-- readme-help-start -->\n\n```yaml\nusage: gcil [-h] [--version] [--no-color] [--update-check] [--settings] [--set GROUP KEY VAL] [-p] [-q]\n [-c CONFIGURATION] [-B] [-A] [-C COMMANDS] [-n NETWORK] [-e ENV] [-E ENGINE] [-H] [--notify] [-r] [-S]\n [--ssh [SSH_USER]] [-v VOLUME] [-w WORKDIR] [--bash | --debug] [--display] [--shell SHELL] [--all]\n [--defaults] [-f] [-i] [-m] [--no-console] [--no-git-safeties] [--no-script-fail] [-R] [--no-verbose]\n [--scripts] [-t TAGS] [-d | -s | -l | --pull | --rmi] [--]\n [names ...]\n\ngcil: Launch .gitlab-ci.yml jobs locally (aliases: gitlabci-local)\n\ninternal arguments:\n -h, --help # Show this help message\n --version # Show the current version\n --no-color # Disable colors outputs with 'NO_COLOR=1'\n # (or default settings: [themes] > no_color)\n --update-check # Check for newer package updates\n --settings # Show the current settings path and contents\n --set GROUP KEY VAL # Set settings specific 'VAL' value to [GROUP] > KEY\n # or unset by using 'UNSET' as 'VAL'\n\npipeline arguments:\n -p, --pipeline # Automatically run pipeline stages rather than jobs\n -q, --quiet # Hide jobs execution context\n -c CONFIGURATION # Path to the .gitlab-ci.yml configuration file or folder\n -B, --no-before # Disable before_script executions\n -A, --no-after # Disable after_script executions\n -C COMMANDS # Run specific commands instead of \"scripts\" commands\n -n NETWORK # Configure the network mode used (or define CI_LOCAL_NETWORK)\n # Choices: bridge, host, none. Default: bridge\n -e ENV # Define VARIABLE=value, pass VARIABLE or ENV file\n -E ENGINE # Force a specific engine (or define CI_LOCAL_ENGINE)\n # Default list: auto,docker,podman\n -H, --host # Run all jobs on the host rather than containers\n --notify # Enable host notifications of pipeline and jobs results\n -r, --real-paths # Mount real folder paths in the container (Linux / macOS only)\n -S, --sockets # Mount engine sockets for nested containers\n # (Enabled by default with services: docker:*dind)\n --ssh [SSH_USER] # Bind SSH credentials to a container's user\n -v VOLUME # Mount VOLUME or HOST:TARGET in containers\n -w WORKDIR # Override the container's working path\n\ndebugging arguments:\n --bash # Prepare runners for manual bash purposes\n --debug # Keep runners active for debugging purposes\n --display # Enable host DISPLAY forwarding features\n --shell SHELL # Configure the default bash/debug shell entrypoint\n\njobs arguments:\n --all # Enable all jobs by default in selections\n --defaults # Use default variables for .local:configurations\n -f, --force # Force the action (use with --pull)\n -i, --ignore-case # Ignore case when searching for names\n -m, --manual # Allow manual jobs to be used\n --no-console # Disable console launch in bash/debug modes\n # (or default settings: [runner] > no_console)\n --no-git-safeties # Disable automated Git safeties configuration\n # (or default settings: [runner] > no_git_safeties)\n --no-script-fail # Fail on missing 'script' nodes of jobs\n # (or default settings: [runner] > no_script_fail)\n -R, --no-regex # Disable regex search of names\n --no-verbose # Hide jobs verbose outputs\n --scripts # Dump parsed jobs entrypoint scripts\n -t TAGS # Handle listed tags as manual jobs\n # Default list: deploy,local,publish\n\nfeatures arguments:\n -d, --dump # Dump parsed .gitlab-ci.yml configuration\n -s, --select # Force jobs selection from enumerated names\n -l, --list # Select one job to run (implies --manual)\n --pull # Pull container images from all jobs\n --rmi # Delete container images from all jobs\n\npositional arguments:\n -- # Positional arguments separator (recommended)\n names # Names of specific jobs (or stages with --pipeline)\n # Regex names is supported unless --no-regex is used\n```\n\n<!-- readme-help-stop -->\n<!-- prettier-ignore-end -->\n\n---\n\n<span class=\"page-break\"></span>\n\n## User configurations with '.local:configurations'\n\n`gcil` implements support for specific user configurations \nallowing simple and interactive local pipeline configurations.\n\nSupported user configurations include `boolean`, `choice`, `input`, `yaml` and `json`.\n\nExamples for each of these can be found in the `configurations` unit tests: [tests/configurations](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/tests/configurations/.gitlab-ci.yml)\n\n---\n\n<span class=\"page-break\"></span>\n\n## Additional features in 'variables'\n\n`gcil` implements further support of most command-line parameters \nusing `variables:` values, either globally or specifically for each job:\n\n<!-- prettier-ignore-start -->\n\n```yaml\nvariables:\n CI_LOCAL_NETWORK: 'str' # Configure the network mode used (see `--network`)\n```\n\n<!-- prettier-ignore-end -->\n\n## Additional features in '.local'\n\n`gcil` implements further support of most command-line parameters \ninside a `.local:` node to ease default parameters definitions.\n\nSupported local values for a `.local` node are:\n\n<!-- prettier-ignore-start -->\n\n```yaml\n.local:\n after: bool # Enable or disable `after_script` executions (see `-A`)\n all: bool # Enable all jobs by default in selections (see `--all`)\n bash: bool # Prepare runners for manual bash purposes (see `--bash`)\n before: bool # Enable or disable `before_script` executions (see `-B`)\n configurations: dict # See [User configurations with '.local:configurations'](#user-configurations-with-localconfigurations)\n debug: bool # Keep runners active for debugging purposes (see `--debug`)\n defaults: bool # Use default variables for `.local:configurations` (see `--defaults`)\n display: bool # Enable host `DISPLAY` forwarding features (see `--display`)\n engine: str # Force a specific engine (see `-E`)\n env: list[str] # Define `VARIABLE=value`, pass `VARIABLE` or `ENV` file (see `-e`)\n image: dict|str # Override container image's `name` and/or `entrypoint\n include: dict # Map `include: project:` names to local paths\n manual: bool # Allow manual jobs to be used (see `--manual`)\n names: list[str] # Names of specific jobs (or stages with `--pipeline`) (see `names`)\n no_console: bool # Disable console launch in bash/debug modes (see `--no-console`)\n no_regex: bool # Disable regex search of names (see `--no-regex`)\n no_verbose: bool # Hide jobs verbose outputs (see `--no-verbose`)\n notify: bool # Enable host notifications of pipeline and jobs results (see `--notify`)\n pipeline: bool # Automatically run pipeline stages rather than jobs (see `-p`)\n quiet: bool # Hide jobs execution context (see `-q`)\n real_paths: bool # Mount real folder paths in the container (see `-r`)\n shell: str # Configure the default bash/debug shell entrypoint (see `--shell`)\n sockets: bool # Mount engine sockets for nested containers (see `-S`)\n ssh: bool|str # Bind SSH credentials to a container's user (see `--ssh`)\n tags: list[str] # Handle listed tags as manual jobs (see `--tags`)\n variables: dict[str] # Define `KEY: VALUE` variables for local jobs\n version: str # Define a minimum version for `gcil` recommended for this file\n volumes: bool # Mount `VOLUME` or `HOST:TARGET` in containers (see `-v`)\n workdir: bool # Override the container's working path (see `-w`)\n```\n\n<!-- prettier-ignore-end -->\n\nExamples for each of these can be found in the `local` unit tests: [tests/local](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/tests/local/.gitlab-ci.yml)\nand [tests/includes](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/tests/includes/.gitlab-ci.project.yml)\n\n---\n\n<span class=\"page-break\"></span>\n\n## Job execution in native context\n\n`gcil` runs every jobs in the specified container image.\n\nFor specific local purposes where the native host context is wished, \nwhere the host tools, folders or credentials are required, \n`image: local` can be used to run the scripts natively.\n\nFor specific purposes, the `image: local:quiet` variant \ncan be used to enable the `quiet` option for specific jobs.\n\nThe `image: local:silent` variant extends the `quiet` option \nby also disabling the verbose script `set -x` line entry.\n\nAn example usage can be found in the local `Changelog` job: [.gitlab-ci.yml](https://gitlab.com/RadianDevCore/tools/gcil/blob/main/.gitlab-ci.yml)\n\n---\n\n<span class=\"page-break\"></span>\n\n## Environment variables\n\n<details>\n <summary>Expand environment variables documentation</summary>\n <div style=\"padding-left: 30px\">\n <br />\n\n`gcil` uses the variables defined in .gitlab-ci.yml, \nparses the simple environment variables file named `.env` \nand the configurations selected through `.local:configurations`.\n\nIf specific environment variables are to be used in the job's container:\n\n- `-e VARIABLE`: pass an environment variable\n- `-e VARIABLE=value`: set a variable to a specific value\n- `-e ENVIRONMENT_FILE`: parse a file as default variables\n\nFor example, `-e TERM=ansi` may enable colored terminal outputs.\n\nThe variable `CI_LOCAL` is automatically defined to `true` by `gcil` \nto allow specific conditions for local purposes in jobs' scripts.\n\nThe variable `CI_LOCAL_HOST` is automatically defined to `true` by `gcil` \nif running the job natively on the host (for example wiht `--host`)\n\nThe following variables are also defined by `gcil`:\n\n- `CI_COMMIT_REF_NAME`: The branch or tag name for which project is built (GitLab CI)\n- `CI_COMMIT_REF_SLUG`: CI_COMMIT_REF_NAME in lowercase, shortened to 63 bytes, \n and with everything except 0-9 and a-z replaced with -. No leading / trailing - (GitLab CI)\n- `CI_COMMIT_SHA`: The commit revision for which project is built (GitLab CI)\n- `CI_COMMIT_SHORT_SHA`: The first eight characters of CI_COMMIT_SHA (GitLab CI)\n- `CI_PROJECT_NAME`: The name of the directory for the project (GitLab CI)\n- `CI_PROJECT_NAMESPACE`: The project namespace (username or group name) of the job (GitLab CI)\n- `CI_LOCAL_USER_HOST_GID`: The host user's group ID value\n- `CI_LOCAL_USER_HOST_UID`: The host user's user ID value\n- `CI_LOCAL_USER_HOST_USERNAME`: The host user's username value\n\n </div>\n\n</details>\n\n---\n\n<span class=\"page-break\"></span>\n\n## Supported container engines\n\n`gcil` currently supports these container engines:\n\n- **Docker :** <https://docs.docker.com/get-docker/> (root daemon, as user or sudoer)\n- **Podman :** <https://podman.io/getting-started/> (rootless or root CLI)\n\n---\n\n## Supported systems\n\n<details>\n <summary>Supported Linux systems</summary>\n <div style=\"padding-left: 30px\">\n\n| Engines | Linux Mint, Ubuntu | CentOS | Others |\n| :-------------------: | :----------------: | :----: | :----: |\n| Native (shell) | **\u2713** | **\u2713** | **?** |\n| Docker (as user) | **\u2713** | **\u2713** | **?** |\n| Docker (as root) | **\u2713** | **\u2713** | **?** |\n| Podman (as user) | **~** | **~** | **?** |\n| Podman (as root) | **\u2713** | **\u2713** | **?** |\n\n </div>\n</details>\n\n<details>\n <summary>Supported macOS systems</summary>\n <div style=\"padding-left: 30px\">\n\n| Engines | macOS (10.14, 10.15, 11.0, ...) |\n| :-------------------: | :-----------------------------: |\n| Native (shell) | **\u2713** |\n| Docker (as user) | **?** |\n\n </div>\n</details>\n\n<span class=\"page-break\"></span>\n\n<details>\n <summary>Supported Windows systems</summary>\n <div style=\"padding-left: 30px\">\n\n| Engines | Windows 10 (1909, 2004, 20H2) | Others |\n| :---------------------: | :---------------------------: | :----: |\n| Native (Command Prompt) | **~** | **?** |\n| Native (Git Bash) | **\u2713** | **?** |\n| Docker (Hyper‑V) | **\u2713** | **?** |\n| Docker (WSL 2) | **\u2713** | **?** |\n\n </div>\n</details>\n\n<details>\n <summary>Supported Android systems</summary>\n <div style=\"padding-left: 30px\">\n\n| Engines | Android (7.0, 7.1, 8.0, 8.1, 9.0, 10, 11, ...) |\n| :-------------: | :--------------------------------------------: |\n| Native (Termux) | **\u2713** |\n\n </div>\n</details>\n\n---\n\n<span class=\"page-break\"></span>\n\n## Compatible projects\n\nMost GitLab CI projects should work with `gcil` without any local-specific changes. \nHowever, if specific configurations like credentials, caches or user rights are needed, the `CI_LOCAL` variable and the `.local:` configurations can be used.\n\nProjects compatible with `gcil` can use this badge to ease things for developers, both as an indicator and a documentation shortcut button :\n\n> [](https://radiandevcore.gitlab.io/tools/gcil)\n\n```markdown title=\"Badge in Markdown\"\n[](https://radiandevcore.gitlab.io/tools/gcil)\n```\n\n```html title=\"Badge in HTML\"\n<a href=\"https://radiandevcore.gitlab.io/tools/gcil\"><img src=\"https://img.shields.io/badge/gcil-enabled-brightgreen?logo=gitlab\" alt=\"gcil\" style=\"max-width:100%;\"></a>\n```\n\n---\n\n<span class=\"page-break\"></span>\n\n## Userspace available settings\n\n`gcil` creates a `settings.ini` configuration file in a userspace folder.\n\nFor example, it allows to change the default engines priority (`[engines] > engine`), \nor to disable the automated updates daily check (`[updates] > enabled`)\n\nThe `settings.ini` file location and contents can be shown with the following command:\n\n```bash\ngcil --settings\n```\n\n---\n\n## Environment available configurations\n\n`gcil` uses `colored` for colors outputs and `questionary` for interactive menus.\n\nIf colors of both outputs types do not match the terminal's theme, \nan environment variable `NO_COLOR=1` can be defined to disable colors.\n\n---\n\n<span class=\"page-break\"></span>\n\n## Dependencies\n\n- [colored](https://pypi.org/project/colored/): Terminal colors and styles\n- [docker](https://pypi.org/project/docker/): Docker Engine API\n- [python-dotenv](https://pypi.org/project/python-dotenv/): Support for .env files parsing\n- [PyYAML](https://pypi.org/project/PyYAML/): YAML parser and emitter for Python\n- [questionary](https://pypi.org/project/questionary/): Interactive terminal user interfaces\n- [setuptools](https://pypi.org/project/setuptools/): Build and manage Python packages\n- [update-checker](https://pypi.org/project/update-checker/): Check for package updates on PyPI\n\n---\n\n## References\n\n- [.gitlab-ci.yml](https://docs.gitlab.com/ee/ci/yaml/): GitLab CI/CD Pipeline Configuration Reference\n- [commitizen](https://pypi.org/project/commitizen/): Simple commit conventions for internet citizens\n- [git-cliff](https://github.com/orhun/git-cliff): CHANGELOG generator\n- [gitlab-release](https://pypi.org/project/gitlab-release/): Utility for publishing on GitLab\n- [OCI](https://opencontainers.org): Open Container Initiative\n- [mkdocs](https://www.mkdocs.org/): Project documentation with Markdown\n- [mkdocs-exporter](https://adrienbrignon.github.io/mkdocs-exporter/): Exporter plugin for mkdocs documentation\n- [mkdocs-material](https://squidfunk.github.io/mkdocs-material/): Material theme for mkdocs documentation\n- [mypy](https://pypi.org/project/mypy/): Optional static typing for Python\n- [pexpect-executor](https://radiandevcore.gitlab.io/tools/pexpect-executor): Automate interactive CLI tools actions\n- [pre-commit](https://pre-commit.com/): A framework for managing and maintaining pre-commit hooks\n- [pre-commit-crocodile](https://radiandevcore.gitlab.io/tools/pre-commit-crocodile): Git hooks intended for developers using pre-commit\n- [PyPI](https://pypi.org/): The Python Package Index\n- [termtosvg](https://pypi.org/project/termtosvg/): Record terminal sessions as SVG animations\n- [Termux](https://termux.com): Linux terminal emulator on Android\n- [twine](https://pypi.org/project/twine/): Utility for publishing on PyPI\n- [winpty](https://github.com/rprichard/winpty): Windows PTY interface wrapper\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Launch .gitlab-ci.yml jobs locally",
"version": "11.0.0",
"project_urls": {
"Bug Reports": "https://gitlab.com/RadianDevCore/tools/gcil/-/issues",
"Changelog": "https://gitlab.com/RadianDevCore/tools/gcil/blob/main/CHANGELOG.md",
"Documentation": "https://gitlab.com/RadianDevCore/tools/gcil#gcil",
"Homepage": "https://gitlab.com/RadianDevCore/tools/gcil",
"Source": "https://gitlab.com/RadianDevCore/tools/gcil",
"Statistics": "https://pypistats.org/packages/gitlabci-local"
},
"split_keywords": [
"gitlab",
"gitlab-ci",
"local",
"gcil",
"gitlabci-local",
"pipeline"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "835860bd3aea09341a90567c5c61fdc1d841fca86253a2665c5020af29ada339",
"md5": "5f7e8351620db49ea5403de6645f4d83",
"sha256": "6e60505c3309e2edc20c54b17725c1e0272aa125af505e14752c090a1db09e10"
},
"downloads": -1,
"filename": "gitlabci_local-11.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5f7e8351620db49ea5403de6645f4d83",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3",
"size": 75636,
"upload_time": "2024-10-28T22:29:55",
"upload_time_iso_8601": "2024-10-28T22:29:55.812906Z",
"url": "https://files.pythonhosted.org/packages/83/58/60bd3aea09341a90567c5c61fdc1d841fca86253a2665c5020af29ada339/gitlabci_local-11.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2a58722db384e6cd90f5a0192034fabb29b4d287f791472842b930385094cf15",
"md5": "6c91f6370ff76714b994cfc134a76dd1",
"sha256": "d0f7848012a44069a4c9b403a6a559ff9467ba45755aada2c199c009d7829138"
},
"downloads": -1,
"filename": "gitlabci_local-11.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6c91f6370ff76714b994cfc134a76dd1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,!=3.7.*,>=3",
"size": 207832,
"upload_time": "2024-10-28T22:29:57",
"upload_time_iso_8601": "2024-10-28T22:29:57.296935Z",
"url": "https://files.pythonhosted.org/packages/2a/58/722db384e6cd90f5a0192034fabb29b4d287f791472842b930385094cf15/gitlabci_local-11.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 22:29:57",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "RadianDevCore",
"gitlab_project": "tools",
"lcname": "gitlabci-local"
}
JSON