Create runtime-tools and image-tools projects #18
Conversation
Signed-off-by: Rob Dolin <robdolin@microsoft.com>
|
LGTM! |
|
LGTM On Tuesday, August 30, 2016, Brandon Philips notifications@github.com
Cheers, Chris Aniszczyk |
| ## Proposal | ||
| With repositories under the http://github.com/OpenContainers organization: | ||
| * Rename the OCITools repository as runtime-tools | ||
| * Create a new repository named image-tools and populate this with the files from: https://github.com/opencontainers/image-spec/tree/master/cmd/oci-image-tool |
There was a problem hiding this comment.
In off-list discussion starting here, I think (and understand @RobDolinMS to agree) that we want to say that the repo names should end with {component}-tools (e.g. runtime-tools). That way the tool maintainers can choose oci-runtime-tools (e.g. to match an installed command) if they like, or choose runtime-tools if there is no installed command to match, or if they (for whatever reason) don't want the repo name to match the installed command.
There was a problem hiding this comment.
I did a bit more research on this and recommend against attempting to align the repo names with CLI commands. Today, the CLI commands are "ocitools" for runtime and "oci-image-tool" for image.
Antonio (@runcom) has also suggested that we use the plural ("tools") instead of singular ("tool") since more tools may be developed in the future.
There was a problem hiding this comment.
+1 on calling it image-tools and runtime-tools. Ship it!
There was a problem hiding this comment.
@philips LGTM! I think this is ready to do an email vote via the @opencontainers/tob mailing list.
There was a problem hiding this comment.
On Wed, Aug 31, 2016 at 02:45:12PM -0700, Rob Dolin (MSFT) wrote:
+* Create a new repository named image-tools and populate this with the files from: https://github.com/opencontainers/image-spec/tree/master/cmd/oci-image-tool
I did a bit more research on this and recommend against attempting
to align the repo names with CLI commands. Today, the CLI commands
are "ocitools" for runtime and "oci-image-tool" for image.
I was expecting we'd rename the installed commands to oci-*-tools. No
sense in having two names when we can use one ;).
Signed-off-by: Rob Dolin <robdolin@microsoft.com>
The validation/unpacking code doesn't really care what the reference and CAS implemenations are. And the new generic interfaces in image/refs and image/cas will scale better as we add new backends than the walker interface. The old tar/directory distinction between image and imageLayout is gone. The new CAS/refs engines don't support directory backends yet (I plan on adding them once the engine framework lands), but the new framework will handle tar/directory/... detection inside layout.NewEngine (and possibly inside a new (cas|refs).NewEngine when we grow engine types that aren't based on image-layout). I'd prefer casLayout and refsLayout for the imported packages, but Stephen doesn't want camelCase for package names [1]. [1]: #159 (comment) Signed-off-by: W. Trevor King <wking@tremily.us>
|
LGTM, I will email the tob list |
|
Thanks for kicking off the vote! The vote tentatively passed (https://groups.google.com/a/opencontainers.org/forum/#!topic/tob/rZ4luMa-pxY) with at least at two-thirds super majority approving the vote, going to merge this change in proactively. |
Currently the OCI seems to have one repository per Project. A few repositories are not official projects; ocitools is just becoming official [1] and artwork [2] may never be a Project. But I expect that going forward, any opencontainers/ repos that have a MAINTAINERS file will be official Projects, so the union rule here should be both correct and easy to maintain. The file is not Markdown, so I've gone with my usual reference-style link instead of a Markdown reference-style link. [1]: opencontainers/tob#18 Subject: Create runtime-tools and image-tools projects [2]: https://github.com/opencontainers/artwork Signed-off-by: W. Trevor King <wking@tremily.us>
Currently the OCI seems to have one repository per Project. A few repositories are not official projects; ocitools is just becoming official [1] and artwork [2] may never be a Project. But I expect that going forward, any opencontainers/ repos that have a MAINTAINERS file will be official Projects, so the union rule here should be both correct and easy to maintain. The file is not Markdown, so I've gone with my usual reference-style link instead of a Markdown reference-style link. [1]: opencontainers/tob#18 Subject: Create runtime-tools and image-tools projects [2]: https://github.com/opencontainers/artwork Signed-off-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Rob Dolin robdolin@microsoft.com