Skip to content

Commit

Permalink
Regenerate readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ralphbean committed Oct 9, 2024
1 parent 1550635 commit 8e093b5
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
18 changes: 8 additions & 10 deletions task/generate-labels/0.1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,25 @@ Usage may look like the following.

> - name: generate-labels
> params:
> - name: LABEL_TEMPLATES
> value:
> - "release=$SOURCE_DATE_EPOCH"
> - "build-date=$SOURCE_DATE"
> - name: label-templates
> value: ["release=$SOURCE_DATE_EPOCH", "build-date=$SOURCE_DATE"]
The following environment variables are defined for use in LABEL_TEMPLATES
The following environment variables are defined for use in label-templates

* ACTUAL_DATE - a date time string containing the time this task runs, formatted +'%Y-%m-%dT%H:%M:%S'
* ACTUAL_DATE - a date time string containing the time this task runs, formatted +'%Y-%m-%dT%H:%M:%SZ'
* ACTUAL_DATE_EPOCH - the timestamp at the time this task runs
* SOURCE_DATE - a date time string containing the provided source timestamp, formatted +'%Y-%m-%dT%H:%M:%S'
* SOURCE_DATE - a date time string containing the provided source timestamp, formatted +'%Y-%m-%dT%H:%M:%SZ'
* SOURCE_DATE_EPOCH - the timestamp provided as a param meant to represent the timestamp at which the source was last modified


## Parameters
|name|description|default value|required|
|---|---|---|---|
|LABEL_TEMPLATES|A list of templates that should be rendered and exposed as a list of labels|[]|false|
|SOURCE_DATE_EPOCH|A standardised environment variable for build tools to consume in order to produce reproducible output.|""|false|
|label-templates|An array of templates that should be rendered and exposed as an array of labels||true|
|source-date-epoch|A standardised environment variable for build tools to consume in order to produce reproducible output.|""|false|

## Results
|name|description|
|---|---|
|LABELS|The rendered labels, rendered from the provided templates|
|labels|The rendered labels, rendered from the provided templates|

2 changes: 1 addition & 1 deletion task/generate-labels/0.1/generate-labels.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ spec:
> - name: label-templates
> value: ["release=$SOURCE_DATE_EPOCH", "build-date=$SOURCE_DATE"]
The following environment variables are defined for use in LABEL_TEMPLATES
The following environment variables are defined for use in label-templates
* ACTUAL_DATE - a date time string containing the time this task runs, formatted +'%Y-%m-%dT%H:%M:%SZ'
* ACTUAL_DATE_EPOCH - the timestamp at the time this task runs
Expand Down

0 comments on commit 8e093b5

Please sign in to comment.