Skip to content

Commit

Permalink
[Tools Projects] Initial Draft
Browse files Browse the repository at this point in the history
  • Loading branch information
RobDolinMS authored Jun 15, 2016
1 parent eba40bd commit 4fa7473
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions proposals/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# OCI Runtime-Tools and Image-Tools Project Proposals

## Abstract
The below proposal contemplates creation of two tools projects (runtime-tools and image-tools.)
These would be associated with the OCI specification projects (runtime-spec and image-spec) and serve as repositories for testing tools.

## Background
Testing tools have been organically developed by the OCI developer community.
These include:
* Runtime-spec test code in a OCITools repository
* Image-spec test code in the image-spec repository
On Wednesday, June 8th, 2016, the OCI developer community discussed potential location(s) for tools associated with specs.

Pro and con arguments were raised for both:
* A. Having test tools in separate repositories for specs (while possibly keeping schemas with the specs)
* B. Keeping test tools in the same repository as a spec (with independent versioning of files)

The below proposal describes option A.

## Proposal
Create runtime-tools and image-tools repositories under the http://github.com/OpenContainers organization.

This comment has been minimized.

Copy link
@wking

wking Jun 15, 2016

My understanding from the 2016-06-08 meeting was that the proposal was going to be closer to “the TOB grants *-spec projects the ability to create *-tools projects if they are so inclined”. The wording here sounds more like “the TOB is creating separate *-tools projects”. I think the rest of this document can handle the more relaxed approach here without major changes, so I'd suggest rewording this section to that effect.

This comment has been minimized.

Copy link
@philips

philips Jun 15, 2016

+1 on just having the TOB give spec maintainers the option.

This comment has been minimized.

Copy link
@wking

wking via email Aug 20, 2016


### Initial Maintainers
Initial maintainers of the runtime-tools project shall be:
* Maintainers of the runtime-spec project
* The four most active contributors (by commit count) to the OCITools project

Initial maintainers of the image-tools project shall be:
* Maintainers of the image-spec project

### Code of Conduct
Both of the proposed projects would incorporate (by referencer) the OCI Code of Conduct from the

### Project Communications
Both of the proposed projects would continue to use existing channels in use by the OCI developer community for communication including:
* GitHub for issues and pull requests
* The [email protected] email list
* The weekly OCI developer community conference call
* The #OpenContainers IRC channel

### Versioning / Roadmap
Released version numbers of the runtime-tools and image-tools projects should roughly align with released verions of the associated specs projects.

This comment has been minimized.

Copy link
@wking

wking Jun 15, 2016

I don't see a particular need to do this. Ocitools versioning, for example, is likely to semantically version the ocitools API (e.g. if a backwards incompatible change is made to that command line, it's a major bump). Which runtime-spec version(s) is (are) supported is an internal detail. opencontainers/runtime-tools#98 and opencontainers/runtime-tools#108 also discuss this versioning and spec-support issue.


It is expected that releases of the tools projects will follow releases of the specs projects by anywhere from a few days to a few months.

0 comments on commit 4fa7473

Please sign in to comment.