opendefensecloud / artifact-conduit / 38745587165
86%

DEFAULT BRANCH: main
Ran
Jobs 1
Files 17
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 86.752% (+1.0%) from 85.775%
38745587165

push

github

web-flow 
docs: add step-by-step walk-through with tested examples (#514)

## What
A step-by-step walk-through that builds a `blob` artifact type from
scratch, with examples that the e2e suite runs.
Closes #186

## Why
The existing examples are complete, but hard to learn from: they show
everything at once and don't explain which part is ARC and which part is
Argo Workflows. The walk-through adds one concept per step, using a real
HTTP → S3 transfer, and links the Argo docs for everything ARC leaves to
Argo.

| Step | Page | What it adds |
| ---- | ---- | ------------ |
| 0 | `setup.md` | kind, Argo Workflows, cert-manager, ARC, SeaweedFS |
| 1 | `first-transfer.md` | `Secret`, `Endpoints`, `WorkflowTemplate`,
`ArtifactType`, `Order`, with a supply chain warning |
| 2 | `verify.md` | Multi-step workflow: sha256 from the `Order` and a
virus scan before `push`, plus a tampered order that fails |
| 3 | `conditionals.md` | Pull from HTTP or S3 with `when`, depending on
the source `Endpoint` |
| 4 | `schedule.md` | A cron `Order` |
| – | `next-steps.md` | The other examples, Argo features not covered,
running ARC in production |

The commands are copy-pasteable, with kubectl (default) and Argo CLI
tabs. The templates list all parameters ARC passes, unused ones as
comments.

## Testing
- e2e: `walk_through_test.go` applies every
`examples/walk-through/NN-*/` directory in order into a `walk-through`
namespace and expects each step's `Order` to succeed. New steps are
picked up automatically. Ran the suite focused on `Extension API
server|Walk-through`: 14 of 20 specs, all passed.
- Docs: extracted every command of the kubectl tabs from the pages and
ran them as a script on a fresh kind cluster, from setup to the end of
step 4, including the expected 404 for the tampered order.
- `mkdocs build`: no new warnings.

## Notes for reviewers
- **`ArtifactType` is immutable** (`api/arc/artifacttype_rest.go`), but
`ClusterArtifactType` is not. Step 3 changes the type's rules, s... (continued)

1421 of 1638 relevant lines covered (86.75%)

2228.7 hits per line

Jobs
ID Job ID Ran Files Coverage
1 38745587165.1 17
86.75
GitHub Action Run
Source Files on build 38745587165