fix: normalize secrets consistently, display accurate help (#11052)

Forgejo's UI claims that whitespace is removed from the beginning and the end of the values of Forgejo Actions variables and secrets. However, that is not correct. The entered values are stored as-is. Only CRLF is replaced with LF, which is also the desired behaviour.

This PR changes the incorrect text which is also no longer displayed as placeholder but as a proper help text below the input fields. Furthermore, tests were added to verify the behaviour.

While adding tests, I discovered and fixed another inconsistency. Depending on whether secrets were managed using the UI or the HTTP API, they were treated differently. CRLF in secrets entered in the UI was correctly replaced with LF while secrets created using the HTTP API kept CRLF.

Fixes #11003.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11052
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch>
Co-committed-by: Andreas Ahlenstorf <andreas@ahlenstorf.ch>
This commit is contained in:
Andreas Ahlenstorf 2026-02-09 17:02:18 +01:00 committed by Gusted
parent dde6c60782
commit f7873ba393
19 changed files with 586 additions and 234 deletions

View file

@ -14,10 +14,11 @@ type Secret struct {
Created time.Time `json:"created_at"`
}
// CreateOrUpdateSecretOption options when creating or updating secret
// CreateOrUpdateSecretOption defines the properties of the secret to create or update.
// swagger:model
type CreateOrUpdateSecretOption struct {
// Data of the secret to update
// Data of the secret. Special characters will be retained. Line endings will be normalized to LF to match the
// behaviour of browsers. Encode the data with Base64 if line endings should be retained.
//
// required: true
Data string `json:"data" binding:"Required"`

View file

@ -3,21 +3,24 @@
package structs
// CreateVariableOption the option when creating variable
// CreateVariableOption defines the properties of the variable to create.
// swagger:model
type CreateVariableOption struct {
// Value of the variable to create
// Value of the variable to create. Special characters will be retained. Line endings will be normalized to LF to
// match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.
//
// required: true
Value string `json:"value" binding:"Required"`
}
// UpdateVariableOption the option when updating variable
// UpdateVariableOption defines the properties of the variable to update.
// swagger:model
type UpdateVariableOption struct {
// New name for the variable. If the field is empty, the variable name won't be updated.
// New name for the variable. If the field is empty, the variable name won't be updated. Forgejo will convert it to
// uppercase.
Name string `json:"name"`
// Value of the variable to update
// Value of the variable to update. Special characters will be retained. Line endings will be normalized to LF to
// match the behaviour of browsers. Encode the data with Base64 if line endings should be retained.
//
// required: true
Value string `json:"value" binding:"Required"`