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 the CI setup #1840

Merged
merged 1 commit into from
May 16, 2017
Merged

Document the CI setup #1840

merged 1 commit into from
May 16, 2017

Conversation

dave-tucker
Copy link
Member

@dave-tucker dave-tucker commented May 16, 2017

This documents the current CI setup and how to run and write tests.

Signed-off-by: Dave Tucker dt@docker.com

docs/ci.md Outdated
LinuxKit CI
===========

The LiunxKit CI system is uses [DatakitCI](https://github.com/moby/datakit/tree/master/ci)
Copy link
Member Author

Choose a reason for hiding this comment

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

s/is uses/uses/g

docs/ci.md Outdated

## PR Testing

Each PR is tested on disposable VM's spawned in Google Cloud Platform
Copy link
Member Author

Choose a reason for hiding this comment

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

on a disposable VM

docs/ci.md Outdated

## Branch and Tag testing

Branches and Tags are tested on disposable VM's spawned in GCP.
Copy link
Member Author

Choose a reason for hiding this comment

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

on disposable VMs

docs/ci.md Outdated
Each PR is tested on disposable VM's spawned in Google Cloud Platform
This machine has no privileges or credentials to talk to GCP or other cloud platforms.

FIXME: Add instructions on how to build a base image for LinuxKitCI and GCP
Copy link
Member Author

Choose a reason for hiding this comment

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

@talex5 I remember we discussed this briefly but don't recall reaching a conclusion.
Using moby to build the CI images would be awesome.

docs/ci.md Outdated

LinuxKit CI runs `make ci-pr` in the VM
This will run the tests using `rtf` and the results directory is SCP'd back to the controller.
The test results will be stored in DataKit for additional access
Copy link
Member Author

Choose a reason for hiding this comment

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

s/additional access//g

@rn
Copy link
Member

rn commented May 16, 2017

Having documentation is good...checking in know inaccurate documentation not so...

I would also prefer if there is one document, maybe docs/testing.md which describes both the CI setup and how devs can run tests (and write tests)

@dave-tucker
Copy link
Member Author

Ok, let me try this another way...
I'll document how it's set up and how it works today.
Then I'll open a PR with suggested improvements, which wouldn't be merged until such times as the improvements are implemented...

@dave-tucker
Copy link
Member Author

Done.

Signed-off-by: Dave Tucker <dt@docker.com>

If the tests pass, the GCP test is run in the same manner as described for PR tests.

Finally, CI will run `make test-ltp` which will run the Linux Testing Project tests.
Copy link
Member

Choose a reason for hiding this comment

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

It would be good to link to the code which does this

Copy link
Member Author

Choose a reason for hiding this comment

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

The link to linuxkit-ci repo is at the top of the section.
I'm not sure linking directly is a good idea as it's likely to change...

@justincormack justincormack merged commit 2aec868 into linuxkit:master May 16, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants