Managing Environment Variables

Use these tutorials to create, edit, and delete global, project, and pipeline environment variables.

Creating Environment Variables

You can create environment variables at the platform badge envvar global, project badge envvar project, and pipeline badge envvar pipeline level. This allows you to create values dedicated to a specific scope without impacting other projects and pipelines.

You can create up to 200 environment variables per platform, project, and pipeline. Once you reach this limit, the create button becomes unavailable, preventing you from creating new environment variables.

  1. Choose whether you want to create a global, project, or pipeline environment variable:

    • Global Environment Variables

    • Project Environment Variables

    • Pipeline Environment Variables

    1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    2. Click a project.
      The project opens on its job library.

    1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    2. Click a project.
      The project opens on its job library.

    3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu.
      Your project’s pipeline library opens.

    4. Click a pipeline.
      The pipeline opens on its The "Overview" page icon is a square divided into several other squares. Overview page.

  2. Click settings env vars a Environment variables from the secondary navigation menu.
    The page opens with the list of existing environment variable.

  3. Click Create variable to create a new environment variables.
    A panel opens that you can edit.

  4. Enter the required information.

    • Environment variable names is mandatory. It has to start with a letter and can be up to 128 characters, including alphanumeric characters (a-z) (A-Z) (0-9) and underscores (_).

    • The environment variable value can be up to 2,048 characters.

      ⇒ Existing environment variables that do not follow these rules are flagged as errors.

    • The description is optional and have no restrictions, but it is a good practice to add it and keep it short and informative.

    • You can select the option is password if your value is a password and must be hidden.

  5. Click Save to confirm the creation.

The created environment variable appears in the list of the corresponding scope, that is, either in the global, project, or pipeline settings env vars a Environment variables page.

To delete environment variables, click the variable you want to delete. In the right-hand panel that opens, scroll to the bottom and click delete Delete. A confirmation message appears, click Delete again to confirm the deletion.
Be careful, because there is no progress bar to cancel the deletion once it is confirmed. Besides, deleting variables used by jobs or custom apps can cause them problems.

Editing Environment Variables

  1. Choose whether you want to modify a global, project, or pipeline environment variable:

    • Global Environment Variables

    • Project Environment Variables

    • Pipeline Environment Variables

    1. Click the The "Projects" module icon is a folder. Projects module from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    2. Click a project.
      The project opens on its job library.

    1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    2. Click a project.
      The project opens on its job library.

    3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu.
      Your project’s pipeline library opens.

    4. Click a pipeline.
      The pipeline opens on its The "Overview" page icon is a square divided into several other squares. Overview page.

  2. Click settings env vars a Environment variables from the secondary navigation menu.
    The page opens with the list of existing environment variable.

  3. Click the variable you want to change in the list.
    A panel opens that you can edit.

  4. Change the information as needed.

    • Environment variable names is mandatory. It has to start with a letter and can be up to 128 characters, including alphanumeric characters (a-z) (A-Z) (0-9) and underscores (_).

    • The environment variable value can be up to 2,048 characters.

      ⇒ Existing environment variables that do not follow these rules are flagged as errors.

    • The description is optional and have no restrictions, but it is a good practice to add it and keep it short and informative.

    • You can select the option is password if your value is a password and must be hidden.

  5. Click Save to save your changes.

Overriding Environment Variables

Environment variables are unique within a scope, but an inferior level can override a higher level. In other words, a project environment variable can override a global environment variable, and a pipeline environment variable can override project and global environment variables. It works the same for both cases.

  1. Navigate to:

    • Project Environment Variables

    • Pipeline Environment Variables

    1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    2. Click a project.
      The project opens on its job library.

    1. Click The "Projects" module icon is a folder. Projects from the primary navigation menu.
      Your project library opens and lists the projects you have created.

    2. Click a project.
      The project opens on its job library.

    3. Click The "Pipelines" page icon is represented by several connected jobs. Pipelines from the secondary navigation menu.
      Your project’s pipeline library opens.

    4. Click a pipeline.
      The pipeline opens on its The "Overview" page icon is a square divided into several other squares. Overview page.

  2. Click settings env vars a Environment variables from the secondary navigation menu.
    The page opens with the list of existing environment variables.

  3. Click the variable you want to override in the list.
    A panel opens that you can edit.

  4. At the bottom of the panel, click Override in this project/pipeline.

  5. Enter the required information for the corresponding scope.

  6. Click Save to save your changes.

The overridden environment variable still exists at the top level and is still applied, except in the current project or pipeline, where it will be applied with the new value.

See also