Reviewing a module pull request Edit

Published on Oct 21, 2017

There are a few things that can be checked if you review a pull request against one of our modules:

  • Does the email address used in the commits match the github email address? (This will let github display the contributor’s avatar next to the commit)
  • Is this a bugfix, modulesync, breaking change, enhancement, docs update? Label it with bug, modulesync, backwards-incompatible, enhancement, docs
  • Are updates to the README.md needed but missing? Label it with needs-docs
  • Has the file documented params or examples in the header? This needs to be updated as well
  • Are there merge conflicts? You don’t need to do anything. Our Vox Pupuli Tasks GitHub App will label this as merge-conflicts and notify the author
  • Were changes to master merged that are required in this PR (for example an updated Travis-CI configuration)? Add the needs-rebase label
  • Does it need additional tests? Add the needs-tests label
  • Does it have failing tests? Add the tests-fail label
  • Does it drop support for a specific Operating system or a major Puppet version? Add the backwards-incompatible label
  • Are new parameters introduced? They must have datatypes
  • Are facts used? They should only be accessed via $facts[] or fact() function from stdlib, but not topscope variables
  • In the majority of cases, variables shouldn’t be accessed via topscope: $::modulename::$param. Instead do: $modulename::$param
  • Are datatypes from stdlib used? Ensure that lowest supported stdlib version is 4.18.0 (This is the first version that supports Puppet 5). Check if a newer version introduced the used datatype
  • Are hiera yaml files added for data-in-modules? Ensure that the data is compatible with hiera 5. Static data that is equal across every supported operating system can stay in the init.pp, it doesn’t need to be moved to a common.yaml
  • Are there new params with datatype Hash or Array? If possible, they should default to empty Hash/Array instead of undef. You can also enforce the datastructure like Array[String[1]]
  • Are there new params with datatype Boolean? The default value is a tricky decision which needs careful reviewing. Sometimes a True/False is the better approach, sometimes undef
  • Is this a bugfix? Write the Pull Request Title in a way that users can easily identify if they are impacted or not
  • Does a new param map to an option in a config file of a service? The Parameter should accept the possible values that the service allows. For example ‘on’ and ‘off’. Don’t accept a boolean that will be converted to ‘on’ or ‘off’
  • Is a new template added? The preferred language is epp, not erb
  • Is a new class added? It should have unit tests using rpsec-puppet-facts that at least verify that the new class compiles
  • Files should always terminate with a newline if possible, with an exception being file or template fragments like those used with concat. This is the POSIX standard, and some tools don’t handle the lack of a terminating newline properly
  • If you can supply one or multiple values for an attribute it’s common practice to enforce the datatype for one value and an array of that datatype. An example for string is Variant[String[1],Array[String[1]]]. This can be used in the Puppet code as [$var].flatten()
  • The parameter section should always be aligned at the = char
  • Is a class considered private? Then it should contain assert_private
  • A module should have as few public interfaces as possible. It should be aimed for the init.pp being the only public class. This is not a rule but a general guideline. Depending on the module, it is not always possible or feasible to configure everything through a single class.
  • Is another module added as a dependency? Add it to the .fixtures.yml file as a git repository (as a https:// link, not ssh or git://). Spec tests always run against master branches to detect breaking changes as early as possible. Acceptance tests use the last release (installed by install_module_dependencies which parses it from the metadata.json)
  • Only hard dependencies must be added to the metadata.json. Don’t add soft dependencies! More explanation is in the official Puppet styleguide
  • Ensure that the version range of any dependency doesn’t include an unreleased major version (do not allow version 6.X of a dependency if the current version is 5.X)
  • An increase of an upper version boundary (of a module or Puppet itself) is only an enhancement if code adjustments were needed. Don’t add the enhancement label if the only change is within the metadata.json. Ensure that .fixtures.yml doesn’t pin a specific version.
  • Sometimes you review a PR where somebody else requested changes. If the contributor clearly fixed it, you can still approve or merge it and ignore the somebody requested changes message. If you are not sure that it is really fixed, only approve it and do not merge it.

Approving and Merging

  • You can merge your own PR if it was approved by a collaborator with merge permissions and travis is green. Don’t merge if either one of those conditions are not true
    • Modulesync PRs are an exception (a PR based on changes that the msync tool did, NOT PRs on modulesync_config). We agreed some time ago that it’s ok to merge your own modulesync PR if travis is green, without separate approval. This is okay because changes to modulesync_config were reviewed and tested
    • If your PR is non-trivial or perhaps has only been approved by a work colleague etc, please consider allowing reasonable extra time for other 3rd parties to leave their reviews before merging. There is no prescribed minimum review period, or definition of ‘reasonable time’. Vox Pupuli trusts collaborators to use their own judgement here.
  • It’s okay to approve code regardless if travis is still running or not. The code won’t be merged if travis fails after the PR got approved
  • You are highly encouraged to review and approve code (or comment on it), even if you do not have merge permissions. This makes further reviews way easier

A green checkmark indicates that the review was done by someone with merge permissions:

8bit vox

If you want to merge:

GitHub provides multiple merge methods:

8bit vox

Our default behaviour is Create a merge commit. Please keep this default. GitHub will automatically sign the merge commit. You can merge it on the CLI if you want to sign the commit with your own GPG key:

# clone the Vox Pupuli repo where you want to merge a Pull Request
git clone [email protected]:voxpupuli/puppet-myawesomemodule.git
# create a temporary branch
git checkout -b temp
# pull the changes from the pullrequest
git pull [email protected]:contributor/puppet-myawesomemodule.git featurebranch_from_the_pr
# switch back to the master branch
git checkout master
# merge the temp branch, that now contains the content from the PR
git merge --no-ff temp
# push the merge commit to the Vox Pupuli master branch
git push origin master
# delete the now obsolete temp branch
git branch -d temp

GitHub has some docs available to help you configuring GPG for git. It’s also good practice to automatically sign every commit. You can enable that with:

git config --global commit.gpgsign true