Document FROM image[[:<tag>]@<digest>] notation as well
#2018
+4
−0
Conversation
This file contains 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
|
Please sign your commits following these rules: $ git clone -b "patch-1" git@github.com:gmarik/cli.git somewhere
$ cd somewhere
$ git commit --amend -s --no-edit
$ git push -fAmending updates the existing PR. You DO NOT need to open a new one. |
Observing usage of comments to document the tag ``` // FROM image:1.2.3 FROM image@sha256:9d6ee4c3dd307 ``` while notation with tag is valid as well ``` FROM image:1.2.3@sha256:9d6ee4c3dd307 ``` Signed-off-by: gmarik <gmarik@gmail.com>
Codecov Report
@@ Coverage Diff @@
## master #2018 +/- ##
=======================================
Coverage 56.79% 56.79%
=======================================
Files 311 311
Lines 21836 21836
=======================================
Hits 12402 12402
Misses 8519 8519
Partials 915 915 |
thaJeztah
added
kind/docs
process/cherry-pick
status/3-docs-review
and removed
status/0-triage
labels
| @@ -568,6 +568,10 @@ Or | |||
|
|
|||
| FROM <image>[@<digest>] [AS <name>] | |||
|
|
|||
| Or combined(though `<tag>` is ignored) | |||
There was a problem hiding this comment.
What about
Or combined (if both `<tag>` and `<digest>` are specified, `<digest>` takes precedence) ?
|
Thank you @gmarik for opening this PR! I just left a comment for small rewording 👍 |
hc0503
approved these changes
Nov 6, 2020
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.
Problem
Seeing usages of comments to document the tag while using
@digestnotation// FROM image:1.2.3 FROM image@sha256:9d6ee4c3dd307But composed notation with tag is valid as well
FROM image:1.2.3@sha256:9d6ee4c3dd307Solution
Document the composed notation
- Description for the changelog
Document
FROM image[[:<tag>]@<digest>]notation as well- A picture of a cute animal (not mandatory but encouraged)