[TEP-0115] Add proposal to support git-based versioning validation in…

… Catlin This commit added a section to propose a new flag `versioning` in Catlin: https://github.com/tektoncd/catlin to support git-based versioning path validation.
tektoncd · Oct 3, 2022 · 7e1f5a9 · 7e1f5a9
1 parent 3c33b95
commit 7e1f5a9
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/teps/0115-tekton-catalog-git-based-versioning.md b/teps/0115-tekton-catalog-git-based-versioning.md
@@ -2,7 +2,7 @@
 status: implementable
 title: Tekton Catalog Git-Based Versioning
 creation-date: '2022-07-12'
-last-updated: '2022-08-08'
+last-updated: '2022-09-28'
 authors:
 - "@jerop"
 - "@vdemeester"
@@ -35,11 +35,13 @@ see-also:
       - [Git Resolver](#git-resolver)
       - [Hub Resolver](#hub-resolver)
       - [HTTP Endpoint](#http-endpoint)
+      - [Tekton Catlin](#tekton-catlin)
   - [Related Work](#related-work)
     - [GitHub Actions](#github-actions)
   - [Future Work](#future-work)
     - [Hub](#hub)
     - [Best Practices](#best-practices)
+    - [Catlin](#catlin)
   - [Alternatives](#alternatives)
     - [One resource per Catalog](#one-resource-per-catalog)
     - [Submodules in Catalogs](#submodules-in-catalogs)
@@ -637,6 +639,19 @@ clusters. These endpoints should continue working as is:
 kubectl apply -f https://api.hub.tekton.dev/v1/resource/tekton/task/buildpacks/0.5/raw
 ```
 
+#### Tekton Catlin
+[Tekton Catlin](https://github.com/tektoncd/catlin) has the capability to validate the file path of catalog resources in the directory-based versioning. The expected resource file path is: ```<catalog>/<resource-type>/<resource-name>/<resource-version>/<resource-name>.yaml``` (e.g. ```catalog/task/git-clone/0.8/git-clone.yaml```).
+
+We propose to add an optional new flag ```versioning``` for [catlin validate](https://github.com/tektoncd/catlin#validate) command and the value can be set to ```git``` or ```directory```, for example:
+
+```shell
+catlin validate <actual-file-path-to-resource> --versioning git
+```
+
+When setting to ```git```, the expected file path is ```<catalog>/<resource-type>/<resource-name>/<resource-name>.yaml``` as required in [Organization Contract](#organization-contract); the expected file path remains unchanged (i.e. ```<catalog>/<resource-type>/<resource-name>/<resource-version>/<resource-name>.yaml```) when setting to ```directory```. The default value of the flag is ```directory```, which will be changed to ```git``` after archiving the [centralized catalog repo](https://github.com/tektoncd/catalog).
+
+Other functionalities of ```Catlin``` should remain the same.
+
 ## Related Work
 
 ### GitHub Actions
@@ -663,6 +678,9 @@ improve the scalability and performance of the Hub - most of this will be implem
 We could provide guidelines and recommendations for creating Catalogs e.g. deciding whether to group resources together
 instead of splitting them into separate Catalogs. We can explore this in future work. 
 
+### Catlin 
+Today, [catlin bump](https://github.com/tektoncd/catlin#bump) command only supports directory-based versioning catalog. We could further extend the [catlin bump](https://github.com/tektoncd/catlin#bump) command to support git-based versioning catalogs (where the command will create a new git tag and a corresponding release note based on the current latest version).
+
 ## Alternatives
 
 ### One resource per Catalog

diff --git a/teps/README.md b/teps/README.md
@@ -281,7 +281,7 @@ This is the complete list of Tekton teps:
 |[TEP-0111](0111-propagating-workspaces.md) | Propagating Workspaces | implemented | 2022-09-16 |
 |[TEP-0112](0112-replace-volumes-with-workspaces.md) | Replace Volumes with Workspaces | proposed | 2022-07-20 |
 |[TEP-0114](0114-custom-tasks-beta.md) | Custom Tasks Beta | implementable | 2022-07-12 |
-|[TEP-0115](0115-tekton-catalog-git-based-versioning.md) | Tekton Catalog Git-Based Versioning | implementable | 2022-08-08 |
+|[TEP-0115](0115-tekton-catalog-git-based-versioning.md) | Tekton Catalog Git-Based Versioning | implementable | 2022-09-28 |
 |[TEP-0116](0116-referencing-finally-task-results-in-pipeline-results.md) | Referencing Finally Task Results in Pipeline Results | implemented | 2022-08-11 |
 |[TEP-0117](0117-tekton-results-logs.md) | Tekton Results Logs | proposed | 2022-08-17 |
 |[TEP-0118](0118-matrix-with-explicit-combinations-of-parameters.md) | Matrix with Explicit Combinations of Parameters | implementable | 2022-08-08 |