mirror of
https://gitea.com/gitea/act_runner.git
synced 2026-08-06 08:54:21 +02:00
b70ff6893a
`::set-env::` and `::add-path::` let a step rewrite the environment of every later step from its own output, which the runner honoured silently. They are now refused, as GitHub has done since 2020, and `ACTIONS_ALLOW_UNSECURE_COMMANDS` opts back in per step or job. Support for that variable is new here too, and is the only opt-in, matching GitHub rather than adding a runner config key on top. Annotations keep their source location: Gitea has no annotation store and its web UI strips command properties, so `::error file=main.go,line=12::msg` is rendered as `::error::main.go:12: msg`. `DEVELOPMENT.md` writes down the log line encoding rules this relies on. --------- Co-authored-by: silverwind <me@silverwind.io> Reviewed-on: https://gitea.com/gitea/runner/pulls/1109 Reviewed-by: silverwind <2021+silverwind@noreply.gitea.com> Co-authored-by: bircni <bircni@icloud.com>
33 lines
1.7 KiB
Markdown
33 lines
1.7 KiB
Markdown
# Development
|
|
|
|
## Job log line format
|
|
|
|
Gitea stores one log row per line and its web UI decodes the payload, so getting the encoding
|
|
wrong never fails a test here, it only shows up in the browser.
|
|
|
|
**A row cannot contain a real newline.** `FormatLog` rewrites `\n` to a literal backslash-n and
|
|
truncates at 64 KiB on a byte boundary.
|
|
|
|
**The payload of a line starting with a recognised prefix is decoded**, with the escape set
|
|
depending on the prefix:
|
|
|
|
| prefix | decodes |
|
|
| --- | --- |
|
|
| `##[error]` `##[warning]` `##[notice]` `##[debug]` `##[group]` `##[endgroup]` `##[add-matcher]` | `%25` `%0D` `%0A` `%3B` `%5D` |
|
|
| `::error::` `::warning::` `::notice::` `::debug::` (with or without ` key=value` properties), `::group::` `::endgroup::` `::add-matcher::` | `%25` `%0D` `%0A` |
|
|
| `##[command]` `[command]`, or no recognised prefix | nothing |
|
|
|
|
### Rules
|
|
|
|
- **Emitting a command line?** Escape the payload with `runner.EscapeCommandData`. One escaper
|
|
covers both forms: it escapes `%` first, so a literal `%3B` becomes `%253B` that the extra
|
|
`##[…]` rules cannot match, and a raw `;` or `]` is never decoded. It is also what makes
|
|
multi-line work, `\n` becomes `%0A` and the UI turns it back into a line break.
|
|
- **Forwarding a command from step output?** Leave the payload alone, it arrived escaped and is
|
|
decoded once. Decoding here double-decodes and destroys multi-line.
|
|
- **No prefix?** Do not escape, and split multi-line values into one row each.
|
|
- **Interpolating a secret?** Masking runs after escaping, so `AppendSecretMasker` registers the
|
|
encoded forms too.
|
|
- Command *properties* also escape `%3A` and `%2C`, which the UI never decodes, so the reporter
|
|
decodes exactly those two when folding a location into an annotation.
|