Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve CLI documentation for pack build --tag #1266

Merged
merged 1 commit into from
Aug 30, 2021

Conversation

importhuman
Copy link
Member

@importhuman importhuman commented Aug 23, 2021

Closes #1136

Signed-off-by: Ujjwal Goyal [email protected]

Summary

Adds a line describing the format of tags to be supplied to pack build image --tag

Documentation

  • Should this change be documented?
    • Yes
    • No

Related

Resolves #1136

@importhuman importhuman requested a review from a team as a code owner August 23, 2021 14:51
@github-actions github-actions bot added the type/enhancement Issue that requests a new feature or improvement. label Aug 23, 2021
@github-actions github-actions bot added this to the 0.21.0 milestone Aug 23, 2021
@codecov
Copy link

codecov bot commented Aug 23, 2021

Codecov Report

Merging #1266 (ee17dc4) into main (c81d8bd) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1266   +/-   ##
=======================================
  Coverage   81.19%   81.19%           
=======================================
  Files         140      140           
  Lines        8596     8596           
=======================================
  Hits         6979     6979           
  Misses       1180     1180           
  Partials      437      437           
Flag Coverage Δ
os_linux 79.83% <100.00%> (+0.07%) ⬆️
os_macos 77.08% <100.00%> (ø)
os_windows 81.09% <100.00%> (ø)
unit 81.19% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Copy link
Contributor

@aemengo aemengo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, I'm a slightly, slightly conflicted by this. Although the help message is correct, it implies that pack is treating a "tag" differently than other tools in the ecosystem. And it's not.

@importhuman
Copy link
Member Author

@aemengo not sure I understand, can you please elaborate? 😅 Any changes you'd suggest?

@jromero
Copy link
Member

jromero commented Aug 24, 2021

To be honest, I'm a slightly, slightly conflicted by this. Although the help message is correct, it implies that pack is treating a "tag" differently than other tools in the ecosystem. And it's not.

@aemengo, I see where you are coming from. This isn't the first time this confusion has come up. I've opened a discussion for this topic. buildpacks/community#128 (comment)

At this point, I'd like to consider keeping that discussion out of this PR and focus on the clarification it's provided for how the implementation currently exists.

@jromero
Copy link
Member

jromero commented Aug 30, 2021

Accepting as-is for now but heavily considering a change to it's implementation to support "true" tags are defined by the OCI spec. See buildpacks/community#128 (comment)

@jromero jromero merged commit 2d5fd5e into buildpacks:main Aug 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve CLI documentation for the pack build --tag flag
3 participants