Release Process

This page documents our development and release flows.

Release Process

The ciao project no longer produces formal tagged releases. Each PR is verified with a series of acceptance tests prior to merge, so the master branch should always be ok to use.

Merging and Reviewing

Because the ciao master must always be ready to release, we will push pull requests only on master. Our master branch is “protected” so that a pull request is required to pass all status checks before it can be merged.

If a pull request is submitted for early feedback and it is not yet ready for merging, it should be marked [DO NOT MERGE] at the start of the subject line.

Merge checklist

In order for a pull request to be merged, all the status checks must pass. In addition, the following manual checks should be made.

1. All the patches have a SOB (we could automate this and make it a travis check if we wanted to)
2. The patches were reviewed by the component owner at least
3. Did the change introduce any new 3rd party dependencies?

• Verify that the license is compatible.
• Verify that the package meets our standards for quality and security.
• Ensure that the package is vendored.

4. Does the pull request require any documentation changes either for architecture or usage?
5. Any new functionality must have a unit test. Test coverage must not be lowered by the pull request.
6. Make sure any new files have an appropriate copyright notice.
7. Ensure that the pull request description is informative.