github.com/secure-build/gitlab-runner@v12.5.0+incompatible/docs/configuration/feature-flags.md (about)

     1  # Feature flags
     2  
     3  > Introduced in GitLab 11.4.
     4  
     5  Feature flags are toggles that allow you to enable or disable specific features. These flags are typically used:
     6  
     7  - For beta features that are made available for volunteers to test, but that are not ready to be enabled for all users.
     8  
     9      Beta features are sometimes incomplete or need further testing. A user who wants to use a beta feature
    10      can choose to accept the risk and explicitly enable the feature with a feature flag. Other users who
    11      do not need the feature or who are not willing to accept the risk on their system have the
    12      feature disabled by default and are not impacted by possible bugs and regressions.
    13  
    14  - For breaking changes that result in functionality deprecation or feature removal in the near future.
    15  
    16      As the product evolves, features are sometimes changed or removed entirely. Known bugs are often fixed,
    17      but in some cases, users have already found a workaround for a bug that affected them; forcing users
    18      to adopt the standardized bug fix might cause other problems with their customized configurations.
    19  
    20      In such cases, the feature flag is used to switch from the old behavior to the new one on demand. This
    21      allows users to adopt new versions of the product while giving them time to plan for a smooth, permanent
    22      transition from the old behavior to the new behavior.
    23  
    24  Feature flags are toggled using environment variables. To:
    25  
    26  - Activate a feature flag, set the corresponding environment variable to `true` or `1`.
    27  - Deactivate a feature flag, set the corresponding environment variable to `false` or `0`.
    28  
    29  ## Available feature flags
    30  
    31  <!--
    32  The list of feature flags is created automatically.
    33  If you need to update it, call `make update_feature_flags_docs` in the
    34  root directory of this project.
    35  The flags are defined in `./helpers/feature_flags/flags.go` file.
    36  -->
    37  
    38  <!-- feature_flags_list_start -->
    39  
    40  | Feature flag | Default value | Deprecated | To be removed with | Description |
    41  |--------------|---------------|------------|--------------------|-------------|
    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_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` |
    44  | `FF_USE_LEGACY_VOLUMES_MOUNTING_ORDER` | `false` | ✓ | 12.6 | Disables the new ordering of volumes mounting when `docker*` executors are being used. |
    45  
    46  <!-- feature_flags_list_end -->