forked from go-gitea/gitea
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update actions variables documents (go-gitea#30394) (go-gitea#30405)
Backport go-gitea#30394 by @lunny Fix go-gitea#30393 Co-authored-by: Lunny Xiao <[email protected]> Co-authored-by: silverwind <[email protected]> Co-authored-by: Zettat123 <[email protected]>
- Loading branch information
1 parent
7287267
commit 40f1f77
Showing
4 changed files
with
80 additions
and
60 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
date: "2024-04-10T22:21:00+08:00" | ||
title: "Variables" | ||
slug: "actions-variables" | ||
sidebar_position: 25 | ||
draft: false | ||
toc: false | ||
menu: | ||
sidebar: | ||
parent: "actions" | ||
name: "Variables" | ||
sidebar_position: 25 | ||
identifier: "actions-variables" | ||
--- | ||
|
||
## 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 be `CI`. | ||
|
||
### Using variable | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
date: "2024-04-10T22:21:00+08:00" | ||
title: "变量" | ||
slug: "actions-variables" | ||
sidebar_position: 25 | ||
draft: false | ||
toc: false | ||
menu: | ||
sidebar: | ||
parent: "actions" | ||
name: "变量" | ||
sidebar_position: 25 | ||
identifier: "actions-variables" | ||
--- | ||
|
||
## 变量 | ||
|
||
您可以创建用户、组织和仓库级别的变量。变量的级别取决于创建它的位置。当创建变量时,变量的名称会被 | ||
转换为大写,在yaml文件中引用时需要使用大写。 | ||
|
||
### 命名规则 | ||
|
||
以下规则适用于变量名: | ||
|
||
- 变量名称只能包含字母数字字符 (`[a-z]`, `[A-Z]`, `[0-9]`) 或下划线 (`_`)。不允许使用空格。 | ||
- 变量名称不能以 `GITHUB_` 和 `GITEA_` 前缀开头。 | ||
- 变量名称不能以数字开头。 | ||
- 变量名称不区分大小写。 | ||
- 变量名称在创建它们的级别上必须是唯一的。 | ||
- 变量名称不能为 `CI`。 | ||
|
||
### 使用 | ||
|
||
创建配置变量后,它们将自动填充到 `vars` 上下文中。您可以在工作流中使用类似 `${{ vars.VARIABLE_NAME }}` 这样的表达式来使用它们。 | ||
|
||
### 优先级 | ||
|
||
如果同名变量存在于多个级别,则级别最低的变量优先。 | ||
仓库级别的变量总是比组织或者用户级别的变量优先被选中。 |