Using GitHub for code review on VIP Go

This notice relates to the following platforms: VIP Go

On Thursday, July 13, 2017, we will move all VIP Go sites to an improved review workflow utilizing GitHub’s Pull Request (PR) workflow.

In the new workflow, when your team has code ready for review you will open a pull request against the master branch. The VIP team will review the code on GitHub and either provide feedback if any changes are required or approve the PR. Approved PRs can be merged at your convenience, which automatically triggers a deploys to your site(s).

The new review workflow leverages GitHub’s excellent code review tools. Among other things, GitHub provides inline commenting, excellent syntax highlighting and diffing, and allows the VIP team to work with your team in a shared UI. In the future we plan to introduce automated code feedback and opportunities for integrating with Continuous Integration systems like Travis CI, CircleCI, and TeamCity.

Our documentation on the new GitHub PR Review Workflow describes the workflow in detail and answers many common questions. If your workflow involves development in an external repo and you need guidance automating the PR creation process, or if you have any other questions or concerns, please open a ticket and we’ll be happy to help.

In summary, the benefits are:

  • You control when your code is deployed to production (including reverts).
  • Code review takes place inline; no more back and forth in tickets.
  • Integration opportunities with automated code feedback and CI systems.

We will move all VIP Go sites to the new workflow on Thursday, July 13, 2017. If you would like to switch sooner, please open a ticket.

As always, if you have questions or thoughts on how we can make your VIP experience better, please get in touch.