Skip to content

Commit 87bb840

Browse files
vdemeestervdemeester
committed
Update tasks READMEs
Signed-off-by: Vincent Demeester <[email protected]>
1 parent 2992f10 commit 87bb840

File tree

3 files changed

+48
-0
lines changed

3 files changed

+48
-0
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# golang-tasks
2+
23
Experimental golang tekton tasks

‎go-crane-image/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,26 @@
11
# go-crane-image
22

33
Build an oci using go and crane.
4+
5+
## Workspaces
6+
7+
| Workspace | Optional | Description |
8+
|:---------------|:--------:|:-------------------------------------------------------|
9+
| `source` | `false` | The go source to build |
10+
| `dockerconfig` | `true` | Includes a docker `config.json` or `.dockerconfigjson` |
11+
12+
## Params
13+
14+
| Param | Type | Default | Description |
15+
|:----------|:--------:|:------------------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
16+
| `app` | `string` | (required) | The name of the "application" to build. This will have an impact on the binary and possibly the image reference |
17+
| `package` | `string` | `.` | The package to build. It needs to be a package `main` that compiles into a binary. The default value is `.`, usual value can be `./cmd/{name}` |
18+
| `image` | `object` | `{ base="", envs="", labels="", push="true", tag="latest" }` | The image specific options such as prefix, labels, env, … |
19+
| `go` | `object` | `{ GOOS="", version="1.18", CGO_ENABLED="0", GOARCH="", GOFLAGS="-v" }` | Golang options, such as flags, version, … |
20+
21+
## Results
22+
23+
| Result | Description |
24+
|:---------------|:--------------------------------|
25+
| `IMAGE_DIGEST` | Digest of the image just built. |
26+
| `IMAGE_URL` | URL of the image just built. |

‎go-ko-image/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,27 @@
11
# go-ko-image
22

33
Build an oci image using go and ko.
4+
5+
## Workspaces
6+
7+
| Workspace | Optional | Description |
8+
|:---------------|:--------:|:-------------------------------------------------------|
9+
| `source` | `false` | The go source to build |
10+
| `dockerconfig` | `true` | Includes a docker `config.json` or `.dockerconfigjson` |
11+
12+
## Params
13+
14+
| Param | Type | Default | Description |
15+
|:----------|:--------:|:-------------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------|
16+
| `app` | `string` | (required) | The name of the "application" to build. This will have an impact on the binary and possibly the image reference |
17+
| `package` | `string` | `.` | The package to build. It needs to be a package `main` that compiles into a binary. The default value is `.`, usual value can be `./cmd/{name}` |
18+
| `flags` | `string` | `--sbom none` | ko extra flags to pass to the ko command |
19+
| `image` | `object` | `{ envs="", labels="", push="true", tag="latest", base="" }` | The image specific options such as prefix, labels, env, … |
20+
| `go` | `object` | `{ CGO_ENABLED="0", GOARCH="", GOFLAGS="-v", GOOS="" }` | Golang options, such as flags, version, … |
21+
22+
## Results
23+
24+
| Result | Description |
25+
|:---------------|:--------------------------------|
26+
| `IMAGE_DIGEST` | Digest of the image just built. |
27+
| `IMAGE_URL` | URL of the image just built. |

0 commit comments

Comments
 (0)