Skip to content

use-prefix.md

Latest commit

 

History

History
26 lines (18 loc) · 1.1 KB

use-prefix.md

File metadata and controls

26 lines (18 loc) · 1.1 KB

Use a prefix for generated variables

Add a prefix to all generated environment variables to avoid naming conflicts with GitHub's default environment variables.

Usage

steps:
  - name: Inject enhanced GitHub environment variables
    uses: rlespinasse/github-slug-action@v5
    with:
      prefix: CI_

With this configuration, variables are named CI_GITHUB_REPOSITORY_SLUG, CI_GITHUB_REF_SLUG, CI_GITHUB_SHA_SHORT, etc.

When to use a prefix

  • When a variable name collides with a GitHub default environment variable (the assignment would be silently ignored without a prefix)
  • When you want to distinguish slug variables from other environment variables in your workflow
  • As a preventive measure against future GitHub environment variable additions

See also