Skip to main content
Version: 1.26.0-rc0

Variables

User-defined variables

You can create configuration variables on the user, organization and repository level. The level of the variable depends on where you created it. When creating a variable, the key will be converted to uppercase. You need use uppercase on the yaml file.

Naming conventions

The following rules apply to variable names:

  • Variable names can only contain alphanumeric characters ([a-z], [A-Z], [0-9]) or underscores (_). Spaces are not allowed.
  • Variable names must not start with the GITHUB_ and GITEA_ prefix.
  • Variable names must not start with a number.
  • Variable names are case-insensitive.
  • Variable names must be unique at the level they are created at.
  • Variable names must not start with CI.

Using variables

After creating configuration variables, they will be automatically filled in the vars context. They can be accessed through expressions like ${{ vars.VARIABLE_NAME }} in the workflow.

Precedence

If a variable with the same name exists at multiple levels, the variable at the lowest level takes precedence: A repository variable will always be chosen over an organization/user variable.

Pre-defined context variables

These variables are available in workflow expressions via ${{ gitea.<name> }}. For compatibility, ${{ github.<name> }} works as an alias.

NameDescriptionExample
gitea.action
github.action
The name of the action currently running, or the id of a step.__run
gitea.action_path
github.action_path
The path where an action is located. Only supported in composite actions./home/runner/work/_actions/actions/checkout/v4
gitea.action_ref
github.action_ref
The ref of the action being executed.v4
gitea.action_repository
github.action_repository
The owner and repository name of the action.actions/checkout
gitea.action_status
github.action_status
The current result of a composite action.success
gitea.actor
github.actor
The username of the user that triggered the initial workflow run.silverwind
gitea.api_url
github.api_url
The URL of the REST API.https://gitea.com/api/v1
gitea.base_ref
github.base_ref
The target branch of a pull request. Only set for pull_request and pull_request_target events.main
gitea.env
github.env
Path on the runner to the file that sets environment variables from workflow commands. Unique to each step./home/runner/work/_temp/_runner_file_commands/set_env_***
gitea.event
github.event
The full event webhook payload as an object.{...}
gitea.event_name
github.event_name
The name of the event that triggered the workflow run.push
gitea.event_path
github.event_path
Path on the runner to the file containing the full event webhook payload./home/runner/work/_temp/_github_workflow/event.json
gitea.head_ref
github.head_ref
The source branch of a pull request. Only set for pull_request and pull_request_target events.feature-branch
gitea.job
github.job
The job_id of the current job.build
gitea.ref
github.ref
The fully-formed ref that triggered the workflow.refs/heads/main
gitea.ref_name
github.ref_name
The short ref name.main
gitea.ref_protected
github.ref_protected
true if branch protections are configured for the ref that triggered the workflow run.true
gitea.ref_type
github.ref_type
The type of ref: branch or tag.branch
gitea.path
github.path
Path on the runner to the file that sets system PATH variables from workflow commands. Unique to each step./home/runner/work/_temp/_runner_file_commands/add_path_***
gitea.repository
github.repository
The owner and repository name.gitea/docs
gitea.repository_owner
github.repository_owner
The repository owner's username.gitea
gitea.repositoryUrl
github.repositoryUrl
The HTML URL to the repository.https://gitea.com/gitea/docs
gitea.retention_days
github.retention_days
The number of days that workflow run logs and artifacts are kept.90
gitea.run_id
github.run_id
A unique number for each workflow run within a repository. Does not change on re-run.1234
gitea.run_number
github.run_number
A unique number for each run of a particular workflow. Starts at 1 and increments with each new run.42
gitea.run_attempt
github.run_attempt
A unique number for each re-run attempt. Starts at 1 and increments with each re-run.1
gitea.secret_source
github.secret_source
The source of a secret used in a workflow. Always Actions in Gitea.Actions
gitea.server_url
github.server_url
The URL of the Gitea instance.https://gitea.com
gitea.sha
github.sha
The commit SHA that triggered the workflow.a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
gitea.token
github.token
A token to authenticate on behalf of the Gitea App installed on the repository. See Token permissions.ghs_***
gitea.triggering_actor
github.triggering_actor
The username of the user that initiated the workflow run. May differ from actor on re-runs.silverwind
gitea.workflow
github.workflow
The name of the workflow. If unnamed, the full path of the workflow file.CI
gitea.workspace
github.workspace
The default working directory on the runner and the default location of your repository when using the checkout action./workspace/gitea/docs
gitea.gitea_default_actions_urlThe default URL for downloading actions. Gitea-specific.https://github.com

Pre-defined environment variables

These environment variables are set automatically in every workflow run and can be accessed directly (e.g. $CI in shell scripts).

Standard environment variables

NameDescriptionExample
CIAlways set to true.true
GITEA_ACTIONSAlways set to true. Useful to distinguish Gitea Actions from other CI systems.true
GITEA_ACTIONS_RUNNER_VERSIONThe version of the act runner executing the workflow.0.2.11
GITEA_ENV
GITHUB_ENV
Path to the file that sets environment variables for subsequent steps./home/runner/work/_temp/_runner_file_commands/set_env_***
GITEA_OUTPUT
GITHUB_OUTPUT
Path to the file that sets step output parameters./home/runner/work/_temp/_runner_file_commands/set_output_***
GITEA_PATH
GITHUB_PATH
Path to the file that adds system PATH entries for subsequent steps./home/runner/work/_temp/_runner_file_commands/add_path_***
GITEA_STATE
GITHUB_STATE
Path to the file that sets step state variables./home/runner/work/_temp/_runner_file_commands/save_state_***
GITEA_STEP_SUMMARY
GITHUB_STEP_SUMMARY
Path to the file for writing job summaries./home/runner/work/_temp/_runner_file_commands/step_summary_***
GITHUB_ACTIONSAlways set to true.true
GITHUB_ACTIONThe name of the action currently running, or the step id.__run
GITHUB_ACTION_PATHThe path where the action is located./home/runner/work/_actions/actions/checkout/v4
GITHUB_ACTION_REFThe ref of the action being executed.v4
GITHUB_ACTION_REPOSITORYThe owner and repository of the action.actions/checkout
GITHUB_ACTORThe username of the user that triggered the workflow.silverwind
GITHUB_API_URLThe URL of the REST API.https://gitea.com/api/v1
GITHUB_BASE_REFThe target branch of a pull request.main
GITHUB_EVENT_NAMEThe name of the event that triggered the workflow.push
GITHUB_EVENT_PATHPath to the file containing the event webhook payload./home/runner/work/_temp/_github_workflow/event.json
GITHUB_GRAPHQL_URLEmpty in Gitea (GraphQL is not supported).(empty)
GITHUB_HEAD_REFThe source branch of a pull request.feature-branch
GITHUB_JOBThe job_id of the current job.build
GITHUB_REFThe fully-formed ref that triggered the workflow.refs/heads/main
GITHUB_REF_NAMEThe short ref name.main
GITHUB_REF_TYPEThe type of ref: branch or tag.branch
GITHUB_REPOSITORYThe owner and repository name.gitea/docs
GITHUB_REPOSITORY_OWNERThe repository owner's username.gitea
GITHUB_RETENTION_DAYSThe number of days that workflow run logs and artifacts are kept.90
GITHUB_RUN_ATTEMPTThe attempt number of the workflow run.1
GITHUB_RUN_IDA unique number for each workflow run.1234
GITHUB_RUN_NUMBERA unique number for each run of a particular workflow.42
GITHUB_SERVER_URLThe URL of the Gitea instance.https://gitea.com
GITHUB_SHAThe commit SHA that triggered the workflow.a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2
GITHUB_WORKFLOWThe name of the workflow.CI
GITHUB_WORKSPACEThe default working directory on the runner./workspace/gitea/docs

Runner environment variables

NameDescriptionExample
RUNNER_ARCHThe architecture of the runner.X64
RUNNER_OSThe operating system of the runner.Linux
RUNNER_TEMPPath to a temporary directory on the runner./tmp
RUNNER_TOOL_CACHEPath to the tool cache directory on the runner./opt/hostedtoolcache

Internal environment variables

These are used internally by the runner and actions. They are typically not needed in workflows directly.

NameDescriptionExample
ACTIONS_CACHE_URLURL for the actions cache service.http://192.168.1.10:8088/
ACTIONS_ID_TOKEN_REQUEST_TOKENToken for OIDC requests. Only set when configured.***
ACTIONS_ID_TOKEN_REQUEST_URLURL to request OIDC tokens. Only set when configured.https://gitea.com/login/oauth/access_token
ACTIONS_RESULTS_URLURL for storing artifacts.https://gitea.com
ACTIONS_RUNTIME_TOKENAuthentication token for the Actions pipeline API.***
ACTIONS_RUNTIME_URLURL for the Gitea Actions pipeline API.https://gitea.com/api/actions_pipeline/