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.

Sign up for GitHub

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

Jump to bottom

Add note about parsing images with digest #12

Closed
wants to merge 1 commit into from
Closed

Add note about parsing images with digest #12

wants to merge 1 commit into from

Conversation

AbdelrahmanElawady
Copy link

Fixes: #11

@AbdelrahmanElawady
Add note about parsing images with digest
7378ee1 
Signed-off-by: AbdelrahmanElawady <abdoelawady125@gmail.com>
@milosgajdos
Copy link
Member

PTAL @thaJeztah

@milosgajdos milosgajdos requested a review from thaJeztah May 8, 2024 16:28
@codecov Codecov
Copy link

codecov bot commented May 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.71%. Comparing base (ff14faf) to head (7378ee1).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main      #12   +/-   ##
=======================================
  Coverage   83.71%   83.71%           
=======================================
  Files           5        5           
  Lines         393      393           
=======================================
  Hits          329      329           
  Misses         54       54           
  Partials       10       10

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@thaJeztah thaJeztah mentioned this pull request May 9, 2024
Draft
thaJeztah
thaJeztah reviewed May 9, 2024
View reviewed changes
Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

Thanks! Left a note / suggestion; I also gave it a quick go, and pushed some to #13 (feel free to take (parts of) those changes if you think they're useful).

reference.go
Comment on lines +4 to +6
// Note: Hash implementation packages must be imported in order
// for digest parsing to work. Example package for sha256: [crypto/sha256]
//
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we should make this a separate section below the Grammar; we could borrow some of the wording from https://pkg.go.dev/github.com/opencontainers/go-digest#readme-usage

Might also be good to include this information in GoDoc for individual functions to describe their behavior.

@AbdelrahmanElawady
Copy link
Author

Well, I didn't know how verbose you wanted the note so I kept it concise. But I see #13 already described it better. So, I believe this PR is obsolete now.
I left a suggestion there and I will close this PR now. Thanks! :)

@AbdelrahmanElawady AbdelrahmanElawady deleted the note-about-digests branch May 10, 2024 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thaJeztah thaJeztah thaJeztah left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Parsing images with digest is not clear
3 participants
@AbdelrahmanElawady @milosgajdos @thaJeztah