doc: Improve godoc for Source Code Spec #1846
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openshift-ci
bot
added
the
release-note-none
pull-request-size
bot
added
the
size/L
openshift-ci
bot
added
the
kind/documentation
Adding clearer descriptions of the source code spec options for `Build` and `BuildRun` objects. This is particularly relevant for the `OCIArtifact` source type, which extracts the contents of a "scratch" container image to a local directory. These updated godoc comments should then get synced to the docs repository and published at https://shipwright.io/docs/ref/api/build/. Signed-off-by: Adam Kaplan <[email protected]>
adambkaplan
force-pushed
the
ociartifact-doc
branch
from
a889226 to
432597b
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: SaschaSchwarze0 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-ci
bot
added
the
approved
4 tasks
|
/lgtm |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Adding clearer descriptions of the source code spec options for
BuildandBuildRunobjects. This is particularly relevant for theOCIArtifactsource type, which extracts the contents of a "scratch" container image to a local directory.These updated godoc comments should then get synced to the docs repository and published at https://shipwright.io/docs/ref/api/build/.
/kind documentation
Submitter Checklist
See the contributor guide
for details on coding conventions, github and prow interactions, and the code review process.
Release Notes