Skip to content

Commit 71ff6d3

Browse files
committed
cicd pipelines summary updated in proposal
Ci-cd pipelines summary added Signed-off-by: Aryan <[email protected]> CICD pipelines Summary updated in lfx proposal Signed-off-by: Aryan <[email protected]>
1 parent 49405f0 commit 71ff6d3

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/proposals/chore/enhance_dependency_management_and_documentation_for_ianvs.md

+12-3
Original file line numberDiff line numberDiff line change
@@ -192,17 +192,21 @@ In order to ensure backward compatibility I will work on developing GitHub Actio
192192
5. Uploading artifacts for debugging.
193193

194194
- Naming Convention
195-
-> Pattern: test-<example-name>.yml
195+
196+
-> Pattern: test-example-name.yml
197+
196198
-> `<example-name>` is a short, unique identifier for the example (e.g., pcb-aoi, llm-cloud-edge).
199+
197200
-> Prefix `test`- indicates it’s a testing workflow, consistent across examples.
201+
198202
-> Location: All files go in`~/ianvs/.github/workflows/`.
203+
199204
- Examples:
200205
- test-pcb-aoi.yml (for the PCB-AoI defect detection example).
201206
- test-llm-cloud-edge.yml (for the LLM cloud-edge collaborative inference example).
202207
- test-other-example.yml (for other examples).
203208

204209
- Examples:
205-
-> PCB-AoI Defect Detection example
206210

207211
GitHub Actions workflow for the `pcb-aoi` example. The following file, named `test-pcb-aoi.yml`, will be placed in the `.github/workflows/` folder.
208212
```yml
@@ -269,9 +273,14 @@ jobs:
269273
workspace/singletask_learning_bench/benchmarkingjob/
270274
*.log
271275
```
276+
The above file: setup the environment, prepare dataset and models, runs the benchmarking job, validates the output and then uploads the artifacts for debugging.
277+
278+
Similarily, workflows for other old examples will be added based on their running instructions.
272279

273-
Similarily other workflows will be added based on their running instructions.
280+
Hence, in summary, the goal of developing CI-CD pipelines will be to ensure that:
274281

282+
- For any new submission (pull requests or merges), all historical (existing) examples remain executable.
283+
- For newly submitted examples, there will be a template that contributors adding new examples can refer to it and create the CI-CD workflow for their specific example themselves. This new template "How to Add CI-CD" will placed in [CONTRIBUTION section](https://github.com/kubeedge/ianvs/tree/main/docs/guides) of [ianvs web doc site](https://ianvs.readthedocs.io/en/latest/guides/how-to-contribute-test-environments.html).
275284

276285
## Roadmap
277286

0 commit comments

Comments
 (0)