Skip to content

Commit c8e4415

Browse files
committed
Add manual validation checks to comply with Catalog Org TEP
We would need to ensure that the PR submissions are manually validated against the [TEP-003] until we have the [validation tool] added to CI. Signed-off-by: Sunil Thaha <sthaha@redhat.com> --- [TEP-003]: https://github.com/tektoncd/community/blob/master/teps/0003-tekton-catalog-organization.md [validation tool]: tektoncd#413
1 parent d7e5c6d commit c8e4415

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

.github/pull_request_template.md

+19
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,25 @@ review them:
1313
- [ ] Includes [docs](https://github.com/tektoncd/community/blob/master/standards.md#principles) (if user facing)
1414
- [ ] Commit messages follow [commit message best practices](https://github.com/tektoncd/community/blob/master/standards.md#commit-messages)
1515
- [ ] Yaml file complies with [yamllint](https://github.com/adrienverge/yamllint) rules.
16+
- [ ] Complies with [Catalog Orgainization TEP][TEP], see [example]. **Note** [An issue has been filed to automate this validation][validation]
17+
- [ ] File path follows `<kind>/<name>/<version>/name.yaml`
18+
- [ ] Has `README.md` at `<kind>/<name>/<version>/README.md`
19+
- [ ] Has mandatory `metadata.labels` - `app.kubernetes.io/version` the same as the `<version>` of the resource
20+
- [ ] Has mandatory `metadata.annotations` `tekton.dev/pipelines.minVersion`
21+
- [ ] mandatory `spec.description` follows the convention
22+
```yaml
23+
spec:
24+
description: >-
25+
one line summary of the resource
26+
27+
Paragraph(s) to describe the resource.
28+
```
1629

1730
_See [the contribution guide](https://github.com/tektoncd/catalog/blob/master/CONTRIBUTING.md)
1831
for more details._
32+
33+
---
34+
35+
[TEP]: https://github.com/tektoncd/community/blob/master/teps/0003-tekton-catalog-organization.md
36+
[example]: https://github.com/tektoncd/catalog/tree/master/task/git-clone/0.1
37+
[validation]: https://github.com/tektoncd/catalog/issues/413

0 commit comments

Comments
 (0)