diff --git a/docs/_images/user/actions/secret-add.png b/docs/_images/user/actions/secret-add.png index d2807277..35132716 100644 Binary files a/docs/_images/user/actions/secret-add.png and b/docs/_images/user/actions/secret-add.png differ diff --git a/docs/_images/user/actions/secret-list.png b/docs/_images/user/actions/secret-list.png index e447dcc7..9098861a 100644 Binary files a/docs/_images/user/actions/secret-list.png and b/docs/_images/user/actions/secret-list.png differ diff --git a/docs/_images/user/actions/variable-add.png b/docs/_images/user/actions/variable-add.png new file mode 100644 index 00000000..c34c4d3e Binary files /dev/null and b/docs/_images/user/actions/variable-add.png differ diff --git a/docs/_images/user/actions/variable-list.png b/docs/_images/user/actions/variable-list.png new file mode 100644 index 00000000..91c3054f Binary files /dev/null and b/docs/_images/user/actions/variable-list.png differ diff --git a/docs/user/actions.md b/docs/user/actions.md index 856449a8..4a4e1684 100644 --- a/docs/user/actions.md +++ b/docs/user/actions.md @@ -184,6 +184,20 @@ Once the secret is added, its value cannot be changed or displayed. ![secrets list](../_images/user/actions/secret-list.png) +## Variables + +A repository, a user or an organization can hold variables, a set of key/value pairs that are stored in the `Forgejo` database and available to the `workflows` as `${{ vars.KEY }}`. They can be defined from the web interface: + +- in `/org/{org}/settings/actions/variables` to be available in all the repositories that belong to the organization +- in `/user/settings/actions/variables` to be available in all the repositories that belong to the logged in user +- in `/{owner}/{repo}/settings/actions/variables` to be available to the `workflows` of a single repository + +![add a variable](../_images/user/actions/variable-add.png) + +Once the variable is added, its value cannot be changed. + +![variables list](../_images/user/actions/variable-list.png) + ## Workflow reference guide The syntax and semantics of the YAML file describing a `workflow` are _partially_ explained here. When an entry is missing the [GitHub Actions](https://docs.github.com/en/actions) documentation may be helpful because there are similarities. But there also are significant differences that require testing.