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

document current draft for iana submission #618

Merged
merged 5 commits into from
Nov 10, 2021
Merged

Conversation

spiffcs
Copy link
Contributor

@spiffcs spiffcs commented Nov 5, 2021

WIP: Ideally we can discuss this in the afternoon and have a submission by the end of the day

Signed-off-by: Christopher Angelo Phillips christopher.phillips@anchore.com

Signed-off-by: Christopher Angelo Phillips <christopher.phillips@anchore.com>
@github-actions
Copy link

github-actions bot commented Nov 5, 2021

Benchmark Test Results

Benchmark results from the latest changes vs base branch
name                                                   old time/op    new time/op    delta
ImagePackageCatalogers/ruby-gemspec-cataloger-2          1.25ms ± 2%    1.31ms ± 1%  +4.68%  (p=0.008 n=5+5)
ImagePackageCatalogers/python-package-cataloger-2        2.86ms ± 2%    2.97ms ± 1%  +3.63%  (p=0.008 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2     724µs ± 3%     777µs ± 1%  +7.28%  (p=0.008 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                 792µs ± 4%     855µs ± 2%  +7.98%  (p=0.008 n=5+5)
ImagePackageCatalogers/rpmdb-cataloger-2                  800µs ± 3%     821µs ± 0%  +2.60%  (p=0.008 n=5+5)
ImagePackageCatalogers/java-cataloger-2                  11.7ms ± 2%    11.5ms ± 1%    ~     (p=0.095 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                 1.18ms ± 1%    1.18ms ± 1%    ~     (p=0.151 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2       606ns ± 4%     635ns ± 1%  +4.75%  (p=0.008 n=5+5)

name                                                   old alloc/op   new alloc/op   delta
ImagePackageCatalogers/ruby-gemspec-cataloger-2           247kB ± 0%     247kB ± 0%    ~     (p=1.000 n=5+5)
ImagePackageCatalogers/python-package-cataloger-2        1.11MB ± 0%    1.10MB ± 0%    ~     (p=0.548 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2     197kB ± 0%     197kB ± 0%  +0.06%  (p=0.016 n=5+5)
ImagePackageCatalogers/dpkgdb-cataloger-2                 228kB ± 0%     228kB ± 0%    ~     (p=0.151 n=5+5)
ImagePackageCatalogers/rpmdb-cataloger-2                  221kB ± 0%     221kB ± 0%    ~     (p=0.905 n=5+5)
ImagePackageCatalogers/java-cataloger-2                  3.23MB ± 0%    3.24MB ± 0%    ~     (p=0.310 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                 1.29MB ± 0%    1.29MB ± 0%    ~     (p=0.690 n=5+5)
ImagePackageCatalogers/go-module-binary-cataloger-2        336B ± 0%      336B ± 0%    ~     (all equal)

name                                                   old allocs/op  new allocs/op  delta
ImagePackageCatalogers/ruby-gemspec-cataloger-2           6.79k ± 0%     6.79k ± 0%    ~     (all equal)
ImagePackageCatalogers/python-package-cataloger-2         26.3k ± 0%     26.3k ± 0%    ~     (p=0.095 n=5+5)
ImagePackageCatalogers/javascript-package-cataloger-2     5.17k ± 0%     5.17k ± 0%    ~     (all equal)
ImagePackageCatalogers/dpkgdb-cataloger-2                 6.65k ± 0%     6.65k ± 0%    ~     (all equal)
ImagePackageCatalogers/rpmdb-cataloger-2                  6.53k ± 0%     6.53k ± 0%    ~     (all equal)
ImagePackageCatalogers/java-cataloger-2                   58.9k ± 0%     58.9k ± 0%    ~     (p=0.151 n=5+5)
ImagePackageCatalogers/apkdb-cataloger-2                  7.71k ± 0%     7.71k ± 0%    ~     (all equal)
ImagePackageCatalogers/go-module-binary-cataloger-2        9.00 ± 0%      9.00 ± 0%    ~     (all equal)

@spiffcs spiffcs requested a review from a team November 5, 2021 16:47
Signed-off-by: Christopher Angelo Phillips <christopher.phillips@anchore.com>
schema/json/vnd.syft+json Outdated Show resolved Hide resolved
schema/json/vnd.syft+json Outdated Show resolved Hide resolved
schema/json/vnd.syft+json Outdated Show resolved Hide resolved
schema/json/vnd.syft+json Outdated Show resolved Hide resolved
Signed-off-by: Christopher Angelo Phillips <christopher.phillips@anchore.com>
schema/json/vnd.syft+json Outdated Show resolved Hide resolved
schema/json/vnd.syft+json Outdated Show resolved Hide resolved
Signed-off-by: Christopher Angelo Phillips <christopher.phillips@anchore.com>
@spiffcs spiffcs force-pushed the 612-draft-media-type branch 2 times, most recently from 91da78c to 696957f Compare November 8, 2021 21:11
@spiffcs spiffcs marked this pull request as ready for review November 8, 2021 21:12
Signed-off-by: Christopher Angelo Phillips <christopher.phillips@anchore.com>
@spiffcs spiffcs requested a review from a team November 8, 2021 21:13
Copy link
Contributor

@luhring luhring left a comment

Choose a reason for hiding this comment

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

This looks great, @spiffcs! 👏


The version parameter refers to the Syft specification version in use.

version = 1*DIGIT "." 1*DIGIT "." 1*DIGIT
Copy link
Contributor

Choose a reason for hiding this comment

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

Question: does 1*DIGIT only allow for values like 5 and not 50?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good Question - here is the relevant text.
https://www.rfc-editor.org/rfc/rfc2045.html#section-4

I asked the reviewer if we could use x.x.x and they said it was fine extending to M/m/p here.

MIME-VERSION in their specification does only allow for a single digit

version := "MIME-Version" ":" 1*DIGIT "." 1*DIGIT

I can follow up and see what edits we might need for the submission since this is unclear.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll make a follow-up PR when I get more clarity from the governing body. As of right now, they accepted the proposal as is. Edits are welcome should this turn out to be more strict than we need for the version constraints.

@spiffcs spiffcs merged commit 319c6ee into main Nov 10, 2021
@spiffcs spiffcs deleted the 612-draft-media-type branch November 10, 2021 16:28
GijsCalis pushed a commit to GijsCalis/syft that referenced this pull request Feb 19, 2024
* document current draft for IANA submission

Signed-off-by: Christopher Angelo Phillips <christopher.phillips@anchore.com>
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.

3 participants