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

RFC-0005: Artifact Revision format and introduction of Digest #3233

Merged
merged 15 commits into from
Nov 17, 2022

Conversation

hiddeco
Copy link
Member

@hiddeco hiddeco commented Oct 20, 2022

TL;DR

This RFC proposes to establish a canonical Revision format for an Artifact
which points to a specific revision represented as a checksum (e.g. an OCI
manifest digest or Git commit SHA) of a named pointer (e.g. an OCI image tag or
Git tag). In addition, it proposes to include the algorithm name (e.g.
sha256) as a prefix to an advertised checksum for an Artifact and
further referring to it as a Digest, deprecating the Checksum field.

Related to

@hiddeco hiddeco changed the title RFC: draft proposal for artifact revision fmt RFC: proposal for artifact revision format Oct 20, 2022
@hiddeco hiddeco changed the title RFC: proposal for artifact revision format RFC: proposal for Artifact Revision format Oct 20, 2022
@hiddeco hiddeco added the area/rfc Feature request proposals in the RFC format label Oct 20, 2022
@hiddeco hiddeco force-pushed the rfc-artifact-revision-fmt branch 6 times, most recently from c75fcb9 to 14e40a5 Compare October 20, 2022 19:35
@hiddeco hiddeco changed the title RFC: proposal for Artifact Revision format RFC: Artifact Revision format and introduction of digests Oct 20, 2022
@hiddeco hiddeco force-pushed the rfc-artifact-revision-fmt branch 13 times, most recently from feddfe3 to 95da84a Compare October 20, 2022 22:41
@pjbgf pjbgf added this to the GA milestone Oct 21, 2022
@hiddeco hiddeco force-pushed the rfc-artifact-revision-fmt branch 4 times, most recently from d585d22 to 6c66b04 Compare October 21, 2022 13:40
@hiddeco hiddeco modified the milestones: GA, Bootstrap GA Nov 4, 2022
Copy link
Member

@souleb souleb left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @hiddeco

Copy link
Contributor

@darkowlzz darkowlzz left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@phillebaba phillebaba left a comment

Choose a reason for hiding this comment

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

Everything looks good I just have a small comment, but I am fine with dropping it if you do not agree with me.

@phillebaba phillebaba self-requested a review November 8, 2022 17:31
Copy link
Member

@phillebaba phillebaba left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Various typo and structural fixes.

Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
- Properly refer to OCI repository name
- Ensure checksum examples are unique to help distinguish difference
  between Revision and Digest
- Slightly change proposal wordings to explicitly mention deprecation
  of `Checksum` field
- Add reference to OCI digests spec

Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/rfc Feature request proposals in the RFC format
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

7 participants