use nunjucks "square bracket syntax" for steps in docs

Signed-off-by: Brian Fletcher <brian@roadie.io>
This commit is contained in:
Brian Fletcher
2022-12-07 08:00:47 +00:00
parent 4890518e25
commit e5f61559d5
6 changed files with 18 additions and 18 deletions
@@ -703,7 +703,7 @@ spec:
name: Register
action: catalog:register
input:
repoContentsUrl: '{{ steps.publish.output.repoContentsUrl }}'
repoContentsUrl: '{{ steps["publish"].output.repoContentsUrl }}'
catalogInfoPath: '/catalog-info.yaml'
```
@@ -76,7 +76,7 @@ spec:
name: Register
action: catalog:register
input:
repoContentsUrl: ${{ steps.publish.output.repoContentsUrl }}
repoContentsUrl: ${{ steps["publish"].output.repoContentsUrl }}
catalogInfoPath: '/catalog-info.yaml'
```
@@ -169,14 +169,14 @@ These should be moved to `links` under the `output` object instead.
```diff
output:
- remoteUrl: '{{ steps.publish.output.remoteUrl }}'
- entityRef: '{{ steps.register.output.entityRef }}'
- remoteUrl: '{{ steps["publish"].output.remoteUrl }}'
- entityRef: '{{ steps["register"].output.entityRef }}'
+ links:
+ - title: Repository
+ url: ${{ steps.publish.output.remoteUrl }}
+ url: ${{ steps["publish"].output.remoteUrl }}
+ - title: Open in catalog
+ icon: catalog
+ entityRef: ${{ steps.register.output.entityRef }}
+ entityRef: ${{ steps["register"].output.entityRef }}
```
@@ -206,7 +206,7 @@ Alternatively, it's possible to keep the `dash-case` syntax and use brackets for
```yaml
input:
repoUrl: ${{ steps['my-custom-action'].output.repoUrl }}
repoUrl: ${{ steps["my-custom-action"].output.repoUrl }}
```
### Summary
@@ -88,17 +88,17 @@ spec:
name: Register
action: catalog:register
input:
repoContentsUrl: ${{ steps.publish.output.repoContentsUrl }}
repoContentsUrl: ${{ steps["publish"].output.repoContentsUrl }}
catalogInfoPath: '/catalog-info.yaml'
# some outputs which are saved along with the job for use in the frontend
output:
links:
- title: Repository
url: ${{ steps.publish.output.remoteUrl }}
url: ${{ steps["publish"].output.remoteUrl }}
- title: Open in catalog
icon: catalog
entityRef: ${{ steps.register.output.entityRef }}
entityRef: ${{ steps["register"].output.entityRef }}
```
Let's dive in and pick apart what each of these sections do and what they are.
@@ -505,10 +505,10 @@ The main two that are used are the following:
output:
links:
- title: Repository
url: ${{ steps.publish.output.remoteUrl }} # link to the remote repository
url: ${{ steps["publish"].output.remoteUrl }} # link to the remote repository
- title: Open in catalog
icon: catalog
entityRef: ${{ steps.register.output.entityRef }} # link to the entity that has been ingested to the catalog
entityRef: ${{ steps["register"].output.entityRef }} # link to the entity that has been ingested to the catalog
```
## The templating syntax