Skip to content

Conversation

thaJeztah
Copy link
Member

@thaJeztah thaJeztah commented Nov 6, 2022


This package was only used for the deprecated "shortid" syntax. Now that
support for this syntax was removed, we can also remove this package.

This patch deprecates and removes the package, adding temporary aliases pointing
to the new location to ease migration from docker/distribution to the new
distribution/distribution/v3. We should remove those aliases in a future update.

With these changes, the docs look like below:

Screenshot 2022-11-08 at 15 52 50

@codecov-commenter
Copy link

codecov-commenter commented Nov 6, 2022

Codecov Report

Base: 57.06% // Head: 56.54% // Decreases project coverage by -0.51% ⚠️

Coverage data is based on head (8cf5d11) compared to base (c47a966).
Patch coverage: 70.23% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3775      +/-   ##
==========================================
- Coverage   57.06%   56.54%   -0.52%     
==========================================
  Files         105      104       -1     
  Lines       10806    10642     -164     
==========================================
- Hits         6166     6018     -148     
+ Misses       3952     3943       -9     
+ Partials      688      681       -7     
Impacted Files Coverage Δ
configuration/configuration.go 64.38% <ø> (ø)
context/trace.go 93.47% <ø> (ø)
contrib/token-server/main.go 0.00% <0.00%> (ø)
manifest/ocischema/manifest.go 74.19% <ø> (ø)
manifest/schema1/manifest.go 33.82% <ø> (ø)
manifest/schema1/reference_builder.go 94.00% <ø> (ø)
manifest/schema2/manifest.go 80.00% <ø> (-0.40%) ⬇️
reference/normalize.go 79.04% <ø> (+0.59%) ⬆️
reference/reference.go 79.08% <ø> (ø)
reference/regexp.go 90.90% <ø> (ø)
... and 37 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@thaJeztah
Copy link
Member Author

Opened cncf/cncf-fuzzing#236 as well to remove fuzzing for this package

@thaJeztah thaJeztah force-pushed the remove_digestset branch 2 times, most recently from c0a39f3 to ec7531a Compare November 8, 2022 14:52
@thaJeztah thaJeztah changed the title remove unused digestset package Deprecate unused digestset package for go-digest/digestset. Nov 8, 2022
@thaJeztah thaJeztah marked this pull request as ready for review November 8, 2022 15:05
@thaJeztah thaJeztah changed the title Deprecate unused digestset package for go-digest/digestset. digestset: deprecate package in favor of go-digest/digestset Nov 8, 2022
@thaJeztah
Copy link
Member Author

@milosgajdos @corhere PTAL

var ErrDigestAmbiguous = digestset.ErrDigestAmbiguous

// Set is used to hold a unique set of digests which
// may be easily referenced by easily referenced by a string
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
// may be easily referenced by easily referenced by a string
// may be easily referenced by a string

Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you want to address this one @thaJeztah? This conversation was marked resolved without changing the code comment.

Copy link
Member Author

Choose a reason for hiding this comment

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

oh! overlooked it; mistook it for changing the documentation links; fixing now

Copy link
Member Author

Choose a reason for hiding this comment

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

updated; now it's done for real 😂

Copy link
Member

@milosgajdos milosgajdos left a comment

Choose a reason for hiding this comment

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

LGTM but before you merge look into @corhere suggestions -- mind you if you accept the commits they won't add your signature and DCO will fail, so you wanna modify the code directly @thaJeztah

@thaJeztah
Copy link
Member Author

mind you if you accept the commits they won't add your signature and DCO will fail, so you wanna modify the code directly @thaJeztah

Thx for the reminder; yes the suggestions are mixed blessing; nice way to show "this is what I suggest", but horrible that they screw up your commits 😂

Either way; updated; this one should be ready to go 👍

@thaJeztah
Copy link
Member Author

Whoop, still green; @corhere ptal 👍

This package was only used for the deprecated "shortid" syntax. Now that
support for this syntax was removed, we can also remove this package.

This patch deprecates and removes the package, adding temporary aliases pointing
to the new location to ease migration from docker/distribution to the new
distribution/distribution/v3. We should remove those aliases in a future update.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Copy link
Collaborator

@corhere corhere left a comment

Choose a reason for hiding this comment

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

The doc comment could be reflowed, but it's not a big deal as it'll look fine on pkg.go.dev.

@milosgajdos milosgajdos merged commit 9bb63e6 into distribution:main Nov 8, 2022
@thaJeztah thaJeztah deleted the remove_digestset branch November 8, 2022 22:49
@thaJeztah
Copy link
Member Author

The doc comment could be reflowed, but it's not a big deal as it'll look fine on pkg.go.dev.

Yeah, wanted to keep it close to the original for now (the aliases should also be temporarily 🤞)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants