Skip to content

Commit 2361e33

Browse files
zakiskchmouel
authored andcommitted
docs: add deprecation notice of Repository CR PipelineRun status
- Add prominent deprecation notice in repositorycrd.md and statuses.md - State the field will be removed in a future release - Improves wording; no functional changes Signed-off-by: Zaki Shaikh <zashaikh@redhat.com>
1 parent 8f2b37a commit 2361e33

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

docs/content/docs/guide/repositorycrd.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ The Repository CR serves the following purposes:
1515
- Letting you declare [custom parameters]({{< relref "/docs/guide/customparams" >}})
1616
within the `PipelineRun` that can be expanded based on certain filters.
1717

18+
{{< hint danger >}}
19+
The `pipelinerun_status` field in the `Repository` CR is scheduled for deprecation and will be removed in a future release. Please avoid relying on it.
20+
{{< /hint >}}
21+
1822
To configure Pipelines-as-Code, a Repository CR must be created within the
1923
user's namespace, for example `project-repository`, where their CI will run.
2024

docs/content/docs/guide/statuses.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,10 @@ repository.
107107
The most recent five statuses of any PipelineRuns associated with a repository
108108
are stored within the corresponding repository custom resource (CR).
109109

110+
{{< hint danger >}}
111+
The `pipelinerun_status` field in the `Repository` CR is scheduled for deprecation and will be removed in a future release. Please avoid relying on it.
112+
{{< /hint >}}
113+
110114
```console
111115
% kubectl get repo -n pipelines-as-code-ci
112116
NAME URL NAMESPACE SUCCEEDED REASON STARTTIME COMPLETIONTIME

0 commit comments

Comments
 (0)