gitlab.com/jfprevost/gitlab-runner-notlscheck@v11.11.4+incompatible/docs/configuration/feature-flags.md (about)

     1  # Feature flags
     2  
     3  Starting with GitLab Runner 11.4 we added a base support for feature flags in GitLab Runner.
     4  
     5  These flags may be used:
     6  
     7  1. For beta features that we want to make available for volunteers but don't want to enable publicly yet.
     8  
     9      A user who wants to use such feature and accepts the risk, can enable it explicitly while the wide
    10      group of users will be unaffected by potential bugs and regressions.
    11  
    12  1. For breaking changes that need a deprecation and removal after few releases.
    13  
    14      While the product evolves some features may be removed or changed. Sometimes it may be even something
    15      that is generally considered as a bug, but users already managed to find some workarounds for it
    16      and a fix could affect their configurations.
    17  
    18      In that cases the feature flag is used to switch from old behavior to the new wan on demand. Such
    19      fix such ensure that the old behavior is deprecated and marked for removal together with the feature
    20      flag that protects the new behavior.
    21  
    22  At this moment feature flags mechanism is based on environment variables. To make the change hidden behind
    23  the feature flag active a corresponding environment variable should be set to `true` or `1`. To make the
    24  change hidden behind the feature flag disabled a corresponding environment variable should be set to
    25  `false` or `0`.
    26  
    27  ## Available feature flags
    28  
    29  <!--
    30  The list of feature flags is created automatically.
    31  If you need to update it, call `make update_feature_flags_docs` in the
    32  root directory of this project.
    33  The flags are defined in `./helpers/feature_flags/flags.go` file.
    34  -->
    35  
    36  <!-- feature_flags_list_start -->
    37  
    38  | Feature flag | Default value | Deprecated | To be removed with | Description |
    39  |--------------|---------------|------------|--------------------|-------------|
    40  | `FF_K8S_USE_ENTRYPOINT_OVER_COMMAND` | `true` | ✓ | 12.0 | Enables [the fix](https://gitlab.com/gitlab-org/gitlab-runner/merge_requests/1010) for entrypoint configuration when `kubernetes` executor is used |
    41  | `FF_DOCKER_HELPER_IMAGE_V2` | `false` | ✓ | 12.0 | Enable the helper image to use the new commands when [helper_image](https://docs.gitlab.com/runner/configuration/advanced-configuration.html#the-runnersdocker-section) is specified. This will start using the new API that will be used in 12.0 and stop showing the warning message in the build log |
    42  | `FF_CMD_DISABLE_DELAYED_ERROR_LEVEL_EXPANSION` | `false` | ✗ |  | Disables [EnableDelayedExpansion](https://ss64.com/nt/delayedexpansion.html) for error checking for when using [Window Batch](https://docs.gitlab.com/runner/shells/#windows-batch) shell |
    43  | `FF_USE_LEGACY_GIT_CLEAN_STRATEGY` | `false` | ✓ | 12.0 | Disables the new strategy for `git clean` that moves the clean operation after checkout and enables support for `GIT_CLEAN_FLAGS` |
    44  | `FF_USE_LEGACY_BUILDS_DIR_FOR_DOCKER` | `false` | ✓ | 12.3 | Disables the new strategy for Docker executor to cache the content of `/builds` directory instead of `/builds/group-org` |
    45  | `FF_USE_LEGACY_VOLUMES_MOUNTING_ORDER` | `false` | ✓ | 12.6 | Disables the new ordering of volumes mounting when `docker*` executors are being used. |
    46  
    47  <!-- feature_flags_list_end -->