Skip to content

Commit

Permalink
docs: Add more CI examples to CI doc, fixes #8813 (#8964)
Browse files Browse the repository at this point in the history
* docs: add links to more ci examples

Signed-off-by: caelan-io <caelan_u@pipekit.io>

* docs: fix small typo in ci-workflowtemplate.yaml

Signed-off-by: caelan-io <caelan_u@pipekit.io>

* docs: fix spell check err

Signed-off-by: caelan-io <caelan_u@pipekit.io>

* docs: fix diff

Signed-off-by: caelan-io <caelan_u@pipekit.io>
  • Loading branch information
caelan-io authored Jun 16, 2022
1 parent 668c67f commit 19eae92
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
13 changes: 9 additions & 4 deletions docs/walk-through/continuous-integration-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,14 @@

Continuous integration is a popular application for workflows.

One example of a CI workflow is
<https://github.com/argoproj/argo-workflows/tree/master/examples/influxdb-ci.yaml>. Because it uses the concepts
that we've already covered, we don't go into details here.
Some quick examples of CI workflows:

- <https://github.com/argoproj/argo-workflows/tree/master/examples/ci.yaml>
- <https://github.com/argoproj/argo-workflows/tree/master/examples/influxdb-ci.yaml>

And a CI `WorkflowTemplate` example:

- <https://github.com/argoproj/argo-workflows/blob/master/examples/ci-workflowtemplate.yaml>

A more detailed example is <https://github.com/sendible-labs/argo-workflows-ci-example>, which allows you to
create a local CI Workflow for the purposes of learning.
create a local CI workflow for the purposes of learning.
12 changes: 6 additions & 6 deletions examples/ci-workflowtemplate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ metadata:
name: ci
annotations:
workflows.argoproj.io/description: |
This workflows builds and tests Argo Workflows.
It demostrates:
This workflows builds and tests Argo Workflows.
It demonstrates:
* Cache restore and store.
* Publishing test reports.
spec:
Expand Down Expand Up @@ -181,9 +181,9 @@ spec:
- |
go install github.com/jstemmer/go-junit-report@latest
go install github.com/alexec/junit2html@v0.0.2
trap 'cat test.out | go-junit-report | junit2html > test-report.html' EXIT
go test -v ./... 2>&1 > test.out
outputs:
artifacts:
Expand Down

0 comments on commit 19eae92

Please sign in to comment.