Running validation tests from a release #610

alban · 2018-03-20T14:00:55Z

Document how to do a release including the pre-compiled binaries.

docs: update link to spec
docs: move compliance testing to separate doc
docs: update validation test output
docs: how to do a release
docs: how to run tests from a release

Fixes #609

wking · 2018-03-20T18:26:10Z

docs/devel/release.md

+
+- Start at the relevant milestone on GitHub (e.g. https://github.com/opencontainers/runtime-tools/milestones/v0.6.0): ensure all referenced issues are closed (or moved elsewhere, if they're not done). Close the milestone.
+- runtime-tools does not use a [roadmap file](https://github.com/opencontainers/runtime-tools/issues/465) but GitHub milestones. Update the [other milestones](https://github.com/opencontainers/runtime-tools/milestones), if necessary
+- Branch from the latest master, make sure your git status is clean


I think we want backticks for git status.

Also, some of these list entries end in periods (e.g. “Close the milestone.”) and some don't (e.g. this one). I think we should pick whether we want list entries to include trailing punctuation and then be consistent about it. My personal preference is for trailing punctuation, but I'm fine with either approach as long as we're consistent.

wking · 2018-03-20T18:28:26Z

docs/devel/release.md

+[maintainers]: https://github.com/opencontainers/runtime-tools/blob/master/MAINTAINERS
+[mailinglist]: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev
+[gh-new-release]: https://github.com/opencontainers/runtime-tools/releases/new
+


We don't need this trailing blank line.

wking · 2018-03-20T18:30:58Z

docs/devel/release.md

+Ensure the branch is correct:
+
+- Ensure the build is clean!
+  - `git clean -ffdx && make && make test` should work


Which OS/arch(es) are we building for? Just GOOS=linux GOARCH=amd64? Do we want to build for each of the OSes listed here? For some set of arches?

Ideally, all, but I don't know how to do that. Could we start with linux + amd64 in this PR and improve later based on contributions? But we should at least namespace the filename of the tarball correctly.

Could we start with linux + amd64 in this PR and improve later based on contributions?

That's fine with me, but ideally these instructions are the same for all platforms. I think the missing piece is a build farm supporting all of our target platforms. Are we waiting for Windows and Solaris folks to point us at farms for their platforms?

wking · 2018-03-20T18:33:23Z

docs/devel/release.md

+- File a PR
+- Ensure the CI on the release PR is green
+- Send an email to the [mailing list][mailinglist] ([example for v0.5.0](https://groups.google.com/a/opencontainers.org/forum/#!topic/dev/iuWpWUai4_I)) and get reviews from other [maintainers][maintainers].
+- Once the maintainers agree, merge the PR


Should we land local copies of the governance docs that we can link here to expand on “agree”? My last attempt at that was #274, but perhaps the maintainers have a different plan in mind for maintaining governance docs for this project.

wking · 2018-03-20T18:35:57Z

docs/runtime-compliance-testing.md

+
+```
+$ tar xf runtime-tools-v0.6.0.tar.gz
+$ RUNTIME=runc tap ./runtime-tools-v0.6.0/validation/*.t


I think we should be consistent about whether or not we recommend using sudo for the tests. In the “From source” section below, we recommend using sudo, so I think we want to also recommend it here.

wking · 2018-03-20T18:47:51Z

docs/runtime-compliance-testing.md

+
+Check if your release has pre-compiled tests on the [release page][releases] page.
+
+```


You want:

```console

here.

wking · 2018-03-20T18:49:05Z

docs/devel/release.md

+- Attach the release.
+  This is a simple tarball:
+
+```


You want:

```sh

here. Or maybe we should add $ prompts and use:

```console

to be consistent with our other examples.

wking · 2018-03-20T18:50:45Z

docs/devel/release.md

+- Clean your git tree: `sudo git clean -ffdx`.
+
+[changelog]: https://github.com/opencontainers/runtime-tools/blob/master/CHANGELOG.md
+[maintainers]: https://github.com/opencontainers/runtime-tools/blob/master/MAINTAINERS


I'd prefer if these were relative links, e.g. [mantainers]: ../../MANTAINERS, to decouple them from forking and other hosting changes. We can't decouple all of our links from the host URI (e.g. for releases below), but I'd like relative links where the target is also in this Git repository.

wking · 2018-03-20T18:53:18Z

docs/runtime-compliance-testing.md

+$ make runtimetest validation-executables
+```
+
+Runtime validation currently [only supports](docs/runtime-compliance-testing.md) the [OCI Runtime Command Line Interface](doc/command-line-interface.md).


These relative links (and some later ones in this file) need to be updated now that you've moved the text under docs/.

Also, this information is generic for runtime-validation; it's not specific to the “From source” approach. Can you shift it (and some of the text from the next paragraph) up into the “Running the runtime validation suite” section?

wking · 2018-03-20T19:02:52Z

docs/runtime-compliance-testing.md

+Result: PASS
+```
+
+


You only need one blank line here.

alban · 2018-03-21T16:11:52Z

@wking thanks for the review! I'll fix that after I finish my current task (test for namespace path).

runtime-spec v1.0.1 is released. No need to link to a pre-v1 rc anymore. Signed-off-by: Alban Crequy <[email protected]>

Signed-off-by: Alban Crequy <[email protected]>

dongsupark · 2018-08-22T14:53:45Z

Rebased, and addressed review comments by @wking.

zhouhao3 · 2018-08-24T09:24:51Z

README.md

-Files=1, Tests=1,  0 wallclock secs ( 0.01 usr  0.01 sys +  0.03 cusr  0.03 csys =  0.08 CPU)
-Result: PASS
-```
+Use the [runtime validation suite](doc/runtime-compliance-testing.md).


doc -> docs

@q384566678 Good catch. Fixed. Thanks!

@wking

Address review comments written by @wking. * Add a blank line between non-manpage refs and manpage refs. * Add backticks for `git status`. * Append a punctuation mark to each list item. * Use `pull request` instead of `PR`. * Specify `console` format to the example commands * Use relative links instead of static URIs * Remove a trailing blank * Remove trailing whitespaces * Run with sudo whenever it's possible * Use correct relative links * Move sections for running runtime validation one level up to the section `Running the runtime validation suite`. * Use `command -v` instead of `which`. * Elaborate why we should specify the TAP variable. Signed-off-by: Dongsu Park <[email protected]>

wking reviewed Mar 20, 2018

View reviewed changes

alban added 5 commits August 22, 2018 15:38

docs: update link to spec

7aaee9c

runtime-spec v1.0.1 is released. No need to link to a pre-v1 rc anymore. Signed-off-by: Alban Crequy <[email protected]>

docs: move compliance testing to separate doc

294ca2a

Signed-off-by: Alban Crequy <[email protected]>

docs: update validation test output

32857b5

Signed-off-by: Alban Crequy <[email protected]>

docs: how to do a release

25522e1

Signed-off-by: Alban Crequy <[email protected]>

docs: how to run tests from a release

ea0a3b2

Signed-off-by: Alban Crequy <[email protected]>

dongsupark force-pushed the alban/release branch 3 times, most recently from 7203f73 to a55083e Compare August 22, 2018 14:50

zhouhao3 reviewed Aug 24, 2018

View reviewed changes

dongsupark force-pushed the alban/release branch from a55083e to 418cabb Compare August 24, 2018 09:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Running validation tests from a release #610

Running validation tests from a release #610

alban commented Mar 20, 2018

wking Mar 20, 2018

wking Mar 20, 2018

wking Mar 20, 2018

alban Mar 22, 2018

wking Mar 22, 2018

wking Mar 20, 2018

wking Mar 20, 2018

wking Mar 20, 2018

wking Mar 20, 2018

wking Mar 20, 2018

wking Mar 20, 2018

wking Mar 20, 2018

alban commented Mar 21, 2018

dongsupark commented Aug 22, 2018

zhouhao3 Aug 24, 2018

dongsupark Aug 24, 2018


		Check if your release has pre-compiled tests on the [release page][releases] page.

		```

Running validation tests from a release #610

Are you sure you want to change the base?

Running validation tests from a release #610

Conversation

alban commented Mar 20, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alban commented Mar 21, 2018

dongsupark commented Aug 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment