Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Sascha Schwarze <[email protected]>
  • Loading branch information
qu1queee and SaschaSchwarze0 committed Aug 26, 2021
1 parent 568e61b commit b4aac23
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions ships/0006-surface-results-in-buildruns.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ We will have the following:

| Result Name | Naming Convention | Emitted Today | Definition | Notes |
| --------------------------------: | ------------------------------------------: | -------: | ----------: | -----------------------------------: |
| shp-source-default-commit-sha | `shp-source-${sourceType}-${resultName}` | yes | at runtime | `${sourceType}` is `default` as is the only supported git source today |
| shp-source-default-commit-sha | `shp-source-${sourceName}-${resultName}` | yes | at runtime | `${sourceName}` is `default` as `spec.source` has no name. |

#### Future State of Build Results for Sources

Expand Down Expand Up @@ -270,7 +270,7 @@ Should be available before release v1.0.0

- `Strategy Results` could pile up, ending-up in heavy BuildRun objects. As we populate results via Tekton, the size limit of a BuildRun is limited to the one from a Task, which is 4096 bytes, as mentioned in the Tekton Results [documentation](https://github.com/tektoncd/pipeline/blob/main/docs/tasks.md#emitting-results).
- `Build Results` should consider the future adoption of new types, like the `bundle` [one](https://github.com/shipwright-io/build/blob/main/docs/proposals/enable-local-source-code-support.md) or the `local-type` [one](https://github.com/shipwright-io/community/pull/11/).
- Categorizing `Build Results` per type name might be complex, as we will consume results directly from Tekton, where there is no clear indication of their related step, as they come in the form of key/values. Therefore we need to stick to the `shp-source-${sourceType}-${resultName}` naming convention when defining results at runtime.
- Categorizing `Build Results` per type name might be complex, as we will consume results directly from Tekton, where there is no clear indication of their related step, as they come in the form of key/values. Therefore we need to stick to the `shp-source-${sourceName}-${resultName}` naming convention when defining results at runtime.

## Drawbacks

Expand Down

0 comments on commit b4aac23

Please sign in to comment.