A gated commit, gated check-in[1] or pre-tested commit[2] is a software integration pattern that reduces the chances for breaking a build (and often its associated tests) by committing changes into the main branch of version control. This pattern can be supported by a continuous integration (CI) server.[3]

To perform a gated commit the software developer must request a gated commit from the CI server before committing the actual changes to a central location. The CI server merges the local changes with the head of the master branch and performs the validations (build and tests) that make up the gate. So the developer can see if his or her changes break the build without actually committing the changes. A commit to the central location will only be allowed if the gates are cleared.

As an alternative this pattern can be realized using different branches in version control. For instance, GitHub can force all commits to a branch B to be merge commits from pull requests which have successfully been built on the CI server and are up-to-date (i.e. based or rebased on B).[4]

See also

References

  1. ^ "Set build triggers on TFS". Visual Studio. Retrieved 2016-06-18.
  2. ^ "Pre-Tested (Delayed) Commit - TeamCity 9.x Documentation - Confluence". confluence.jetbrains.com. Retrieved 2016-11-25.
  3. ^ "Build Pattern: Gated Commit". Retrieved 2014-08-18.
  4. ^ "Enabling required status checks". GitHub user documentation. Retrieved 2016-06-18.
Categories