Suggested update to PR https://github.com/devfile/api/pull/580 #1
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
Moves GitLocation in DockerfileImage Image component type under the Git struct to make clear that this field is intended only for use when specifying a git repo. (Files not regenerated for readability) Signed-off-by: Angel Misevski <[email protected]>
sleshchenko
reviewed
Aug 11, 2021
| @@ -66,3 +62,11 @@ type Dockerfile struct { | |||
| // +optional | |||
| RootRequired bool `json:"rootRequired,omitempty"` | |||
| } | |||
|
|
|||
| type DockerfileGitProjectSource struct { | |||
| GitProjectSource `json:",inline"` | |||
There was a problem hiding this comment.
Should it really be GitProjectSource? Like why dockerfileGitSource needs a name, attributes, clonePath?
There was a problem hiding this comment.
I think the main concern was reusing the struct from projects/starterprojects
Like why dockerfileGitSource needs a name, attributes, clonePath?
I'm not sure what you mean -- with this change, a component would look something like
components:
- name: my-component
image:
git:
gitLocation: "build/Dockerfile"
checkoutFrom:
remote: amisevsk
revision: devel-branch
remotes:
origin: https://github.com/devfile/api
amisevsk: https://github.com/amisevsk/api(with checkoutFrom optional when there's only one remote)
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
maysunfaisal
approved these changes
Aug 11, 2021
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.
What does this PR do?
As we briefly discussed, this PR is an example of embedding the GitProjectSource into another struct in order to extend it with additional fields. This allows reuse of the existing GitProjectSource, which is reused elsewhere in the API, while moving the Git-only field
GitLocationwithin that section of JSON.I didn't regenerate files for readability, but the net effect is moving the
GitLocationfield down a level.What issues does this PR fix or reference?
Is your PR tested? Consider putting some instruction how to test your changes
Docs PR