Skip to content
This repository has been archived by the owner on Jul 18, 2023. It is now read-only.

Guidance for Artifact Authors #13

Merged
merged 12 commits into from
Apr 30, 2020
Merged

Conversation

SteveLasker
Copy link
Contributor

@SteveLasker SteveLasker commented Oct 3, 2019

Artifacts Guidance:
This is the first of a few PRs that were tasked by the OCI TOB to serve 3 primary goals
This PR addresses how Artifact Authors utilize OCI manifest to push new artifact types to an OCI-distribution based registry.
Subsequent PRs will address

  • publishing well-known types, including registering with IANA and artifact publishing samples
  • what registry operators need, to support artifacts

This is ready for final review:

Signed-off-by: Steven Lasker <stevenlasker@hotmail.com>
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Copy link
Contributor Author

@SteveLasker SteveLasker left a comment

Choose a reason for hiding this comment

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

Just a general comment:
Thank you all for the feedback. To manage quick response time iterating on ideas to incorporate, vs. focused spec time with PRs, I'll incorporate the feedback I thumbed up next week, as well as address some of the questions that should be incorporated into the spec.

Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

See comments regarding the first few sections..

spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steven Lasker <stevenlasker@hotmail.com>
Signed-off-by: Steven Lasker <stevenlasker@hotmail.com>
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
@SteveLasker
Copy link
Contributor Author

A quick note. I've been following up with using Iana.org for the mediaType registration process. (https://www.iana.org/form/media-types) It looks very promising, with

  • vnd. for vendors
  • prs. tree: for personal
  • x. for unregistered, such as customer specific, or registry specific types.

I've registered vnd.oci.image to see how the process works. Once I have more info, I'll be able to complete that section and hopefully move to merging this spec as the basis.

spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
@SteveLasker
Copy link
Contributor Author

SteveLasker commented Apr 24, 2020

Moving to the description to avoid being lost in detail.

Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

comments half way..

spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

See comments / questions. Mostly nits :-)

spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

LGTM
good first pass

Copy link
Member

@dmcgowan dmcgowan left a comment

Choose a reason for hiding this comment

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

The content in this PR looks good but the conversion of this repository into a versioned spec should be broken out. I'm not convinced the Artifacts Specification section has actually defined a specification. The primary goals and everything after scope LGTM.

spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

couple comments on the versioning/scope issue

spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
spec.md Outdated Show resolved Hide resolved
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
Copy link
Member

@dmcgowan dmcgowan 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
Contributor

@josephschorr josephschorr left a comment

Choose a reason for hiding this comment

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

Mostly word smithing (which you're free to ignore). I also had one or two clarification points.

artifact-authors.md Outdated Show resolved Hide resolved
artifact-authors.md Outdated Show resolved Hide resolved
artifact-authors.md Outdated Show resolved Hide resolved
artifact-authors.md Outdated Show resolved Hide resolved
artifact-authors.md Outdated Show resolved Hide resolved
artifact-authors.md Show resolved Hide resolved
artifact-authors.md Outdated Show resolved Hide resolved
artifact-authors.md Show resolved Hide resolved
Copy link
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

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

LGTM

@mikebrow mikebrow changed the title Artifacts Spec Guidance for Artifact Authors Apr 30, 2020
Signed-off-by: Steve Lasker <stevelasker@hotmail.com>
Copy link
Member

@mikebrow mikebrow 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
Contributor

@josephschorr josephschorr 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

@dmcgowan dmcgowan 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

@stevvooe stevvooe left a comment

Choose a reason for hiding this comment

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

LGTM

@mikebrow mikebrow merged commit f86648a into opencontainers:master Apr 30, 2020
jdolitsky added a commit to bloodorangeio/artifacts that referenced this pull request Feb 9, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.