You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .tekton/README.md
+26-12
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,10 @@
1
1
## π οΈ CI/CD Pipeline Overview β Your Project
2
2
3
-
This pipeline is designed to support safe, efficient, and traceable development and deployment workflows using OpenShift Pipelines-as-Code, GitHub, and Quay.io.
3
+
<!-- NOTE TO CONTRIBUTORS: every repo in the hc4ai organization is intended to have the same contents in this file. The origin is the copy in https://github.ibm.com/mspreitz/hc4ai-hello-neural/blob/dev/.tekton/README.md; submit PRs against that one -->
4
+
5
+
This pipeline is designed to support safe, efficient, and traceable development and deployment workflows using [OpenShift Pipelines-as-Code](https://pipelinesascode.com/), [Tekton](https://tekton.dev/), [buildah](https://buildah.io/), GitHub, and Quay.io.
6
+
7
+
This pipeline is used for CI/CD of the `dev` and `main` branches. This pipeline runs from source through container image build to deployment and testing in the hc4ai cluster.
4
8
5
9
---
6
10
@@ -24,19 +28,28 @@ Each repo includes a `.version.json` file at its root. This file controls:
24
28
25
29
#### π Fields:
26
30
-**dev-version**: Current version of the dev branch. Used to tag dev images.
27
-
-**dev-registry**: Container registry location for development image pushes.
31
+
-**dev-registry**: Container repository location for development image pushes.
28
32
-**prod-version**: Managed by automation. Updated during promotion to match the dev-version.
29
-
-**prod-registry**: Container registry for production image pushes. The promoted dev image is re-tagged and pushed here.
33
+
-**prod-registry**: Container repository for production image pushes. The promoted dev image is re-tagged and pushed here.
30
34
31
35
The pipeline reads this file to:
32
36
- Extract the appropriate version tag
33
-
- Determine the correct registry for image pushes
37
+
- Determine the correct repository for image pushes
34
38
- Promote and tag dev images for prod
35
39
36
40
---
37
41
42
+
### Container Repositories
43
+
44
+
This pipeline maintains two container repositories for this GitHub repository, as follows.
45
+
46
+
-`quay.io/vllm-d/<repoName>-dev`. Hold builds from the `dev` branch as described below.
47
+
-`quay.io/vllm-d/<repoName>`. Holds promotions to prod, as described below.
48
+
49
+
---
50
+
38
51
### βοΈ Pipeline Triggers
39
-
Triggered on `push` and `pull_request` events targeting the `dev` or `main` branches.
52
+
Triggered on `push` and `pull_request` events targeting the `dev` or `main` branches. The following workflows are the two behaviors of this pipeline.
40
53
41
54
### π§ dev Branch Workflow
42
55
1. Checkout repository
@@ -47,20 +60,20 @@ Triggered on `push` and `pull_request` events targeting the `dev` or `main` bran
47
60
- prod-version
48
61
- prod-registry
49
62
4. Build and push container image to:
50
-
β `<dev-registry>:<dev-version>`
63
+
β `<dev-repository>:<dev-version>`
51
64
5. Tag the Git commit using the `dev-version`
52
-
6. Optionally redeploy objects to OpenShift in `hc4ai-operator-dev`
65
+
6. Optionally redeploy objects to OpenShift in the `hc4ai-operator-dev` namespace.
53
66
54
67
β This process ensures that all code merged into dev is validated and deployed for testing.
55
68
56
69
### π main Branch Workflow
57
70
1. Checkout, lint, test, and parse `.version.json`
0 commit comments