Skip to content

Commit bf091f4

Browse files
committed
docs: add gitops_command_prefix to settings ref
Document gitops_command_prefix in the Repository settings API reference. The field is already supported and covered in the GitOps guide, but it was missing from the settings reference that claims to describe all available fields. Add the reference entry and cross-link back to the behavior guide. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
1 parent ae815af commit bf091f4

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/content/docs/api/settings.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,19 @@ settings:
3232
3333
{{< /param >}}
3434
35+
{{< param name="gitops_command_prefix" type="string" id="param-gitops-command-prefix" >}}
36+
Sets a custom prefix for GitOps commands such as `/test`, `/retest`, and `/cancel`.
37+
Use a plain word such as `pac`; Pipelines-as-Code adds the leading slash
38+
automatically. For command behavior and examples, see the
39+
[GitOps commands guide]({{< relref "/docs/guides/gitops-commands/advanced" >}}).
40+
41+
```yaml
42+
settings:
43+
gitops_command_prefix: "pac"
44+
```
45+
46+
{{< /param >}}
47+
3548
{{< param name="policy" type="Policy" >}}
3649
Defines authorization policies for the repository. These policies control which users can trigger PipelineRuns under different conditions.
3750

0 commit comments

Comments
 (0)