Skip to content

Commit

Permalink
Linting (wrap to 80 char columns)
Browse files Browse the repository at this point in the history
  • Loading branch information
@runejuhl
runejuhl committed Mar 12, 2019
1 parent 3dabd07 commit b2af595
Showing 1 changed file with 132 additions and 52 deletions.
184 changes: 132 additions & 52 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,47 +45,77 @@ You will have someone by your side in this process. The general flow is to…
* At that point you can transfer your own repository.
* If migrating a module from puppetlabs, re-enable github issues.
* Verify that all webhooks except travis are disabled.
* Update the README.md with a description of the deprecation and a link to the new module location.
* Update the README.md with a description of the deprecation and a link to the
new module location.
* Release a copy of your module to the 'puppet' forge account.
* Add the module to our [modulesync setup](https://github.com/voxpupuli/modulesync_config/blob/master/managed_modules.yml).
* Add the module to our [plumbing repository](https://github.com/voxpupuli/plumbing/blob/master/share/modules)(handles travis secrets).
* Ask an admin to add the `collaborators` team to the module's `Collaborators & Teams` 'Teams' list with `Write` permissions (e.g. https://github.com/voxpupuli/puppet-gitlab/settings/collaboration).
* Add the module to our [modulesync
setup](https://github.com/voxpupuli/modulesync_config/blob/master/managed_modules.yml).
* Add the module to our [plumbing
repository](https://github.com/voxpupuli/plumbing/blob/master/share/modules)(handles
travis secrets).
* Ask an admin to add the `collaborators` team to the module's `Collaborators &
Teams` 'Teams' list with `Write` permissions (e.g.
https://github.com/voxpupuli/puppet-gitlab/settings/collaboration).
* Execute modulesync for this module.
* Create a Jira issue at https://tickets.puppetlabs.com and ask to deprecate the old module (and approve the new one if the old one was approved as well).

If you have many modules you wish to migrate, this will be cumbersome.
In this case we will generally create a separate group and give you
administrator access to speed things up.

If you are interested in Vox Pupuli accepting a module *that you do not own*, the process has a few extra steps before beginning the checklist above.
We do ask that you show that reasonable efforts have been made to engage the owner and they are unresponsive.
If the owner has responded and is not interested in migrating their module to VP, it will be evaluated on a case by case basis.
To start the process, document your request and efforts in a brief email to the [mailing list](https://groups.io/g/voxpupuli/).
If the module is accepted, VP will work with you to determine the proper fork/migration steps needed in addition to the checklist above.
* Create a Jira issue at https://tickets.puppetlabs.com and ask to deprecate the
old module (and approve the new one if the old one was approved as well).

If you have many modules you wish to migrate, this will be cumbersome. In this
case we will generally create a separate group and give you administrator access
to speed things up.

If you are interested in Vox Pupuli accepting a module *that you do not own*,
the process has a few extra steps before beginning the checklist above. We do
ask that you show that reasonable efforts have been made to engage the owner and
they are unresponsive. If the owner has responded and is not interested in
migrating their module to VP, it will be evaluated on a case by case basis. To
start the process, document your request and efforts in a brief email to the
[mailing list](https://groups.io/g/voxpupuli/). If the module is accepted, VP
will work with you to determine the proper fork/migration steps needed in
addition to the checklist above.

## Publishing a module - setup
Forge publishing is handled by travis and puppet-blacksmith.

To guarantee a frictionless process across all modules, we use [modulesync](https://github.com/voxpupuli/modulesync). Our modulesync configuration is available at [modulesync_config](https://github.com/voxpupuli/modulesync_config).
To guarantee a frictionless process across all modules, we use
[modulesync](https://github.com/voxpupuli/modulesync). Our modulesync
configuration is available at
[modulesync_config](https://github.com/voxpupuli/modulesync_config).

Most modulesync'ed settings can be overridden through a [.sync.yml](https://github.com/voxpupuli/puppet-extlib/blob/master/.sync.yml). You may also need to (re)define your travis testing matrix with respect to puppet version. This prevents the deploy hook from running once for each version of puppet defined in your testing.
Most modulesync'ed settings can be overridden through a
[.sync.yml](https://github.com/voxpupuli/puppet-extlib/blob/master/.sync.yml).
You may also need to (re)define your travis testing matrix with respect to
puppet version. This prevents the deploy hook from running once for each version
of puppet defined in your testing.

Travis needs to be aware of the rename, this can be done by pushing a single commit. Travis needs to be enabled for the new repository, you can do that [here](https://travis-ci.org/profile/voxpupuli).
Travis needs to be aware of the rename, this can be done by pushing a single
commit. Travis needs to be enabled for the new repository, you can do that
[here](https://travis-ci.org/profile/voxpupuli).

The secure line is unique per repository and often the only line in .sync.yml. To get a secure line:
The secure line is unique per repository and often the only line in .sync.yml.
To get a secure line:

Ask an admin (or submit a PR) to add your module to the list [here](https://github.com/voxpupuli/plumbing/blob/master/share/modules). Then an admin will run the encrypt_travis.sh script and push a new version of [this](https://github.com/voxpupuli/plumbing/blob/master/share/travis_secrets) which you can then copy and paste your travis secure line from.
Ask an admin (or submit a PR) to add your module to the list
[here](https://github.com/voxpupuli/plumbing/blob/master/share/modules). Then an
admin will run the encrypt_travis.sh script and push a new version of
[this](https://github.com/voxpupuli/plumbing/blob/master/share/travis_secrets)
which you can then copy and paste your travis secure line from.

Note that you need to mask your ``secure:`` line in .travis.yml from modulesync. [Here](https://github.com/voxpupuli/puppet-iis/blob/master/.sync.yml#L35) is an example of what that looks like.
Note that you need to mask your ``secure:`` line in .travis.yml from modulesync.
[Here](https://github.com/voxpupuli/puppet-iis/blob/master/.sync.yml#L35) is an
example of what that looks like.

If the forge puppet password is changed, an admin can run encrypt_travis.sh and the modules can bring in the new password on their own schedule.
If the forge puppet password is changed, an admin can run encrypt_travis.sh and
the modules can bring in the new password on their own schedule.


Gem publishing is handled similarly, except there is not a unified user. Each gem owner is responsible for their own .travis.yml
Gem publishing is handled similarly, except there is not a unified user. Each
gem owner is responsible for their own .travis.yml

## Releasing a new version of a module

*Please note that in order to perform a release you must be in the __Collaborators__ group on Github for the module in question.*
*Please note that in order to perform a release you must be in the
__Collaborators__ group on Github for the module in question.*

Run modulesync to ensure the dotfiles are up to date.

Expand Down Expand Up @@ -138,45 +168,95 @@ Travis will then kick off a build against the new tag created and deploy that bu

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`
* 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? 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
* Are new parameters introduced? They must have datatypes
* Are facts used? They should only be accessed via `$facts[]` or [fact()](https://github.com/puppetlabs/puppetlabs-stdlib#fact) 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.13.1. Check if a newer version introduced the used datatype
* Are hiera yaml files added for data-in-modules? Ensure that the lowest supported Puppet version is 4.10.0 and that the data is compatible with [hiera 5](https://puppet.com/docs/puppet/5.3/hiera_migrate.html#use-cases-for-upgrading-to-hiera-5)
* 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](https://puppet.com/docs/puppet/latest/lang_template_epp.html), not [erb](https://puppet.com/docs/puppet/latest/lang_template_erb.html)
* Is a new class added? It should have unit tests using [rpsec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts#rspec-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](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206), 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()`
* 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()`
* Are facts used? They should only be accessed via `$facts[]` or
[fact()](https://github.com/puppetlabs/puppetlabs-stdlib#fact) 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.13.1. Check if a newer version introduced the used datatype
* Are hiera yaml files added for data-in-modules? Ensure that the lowest
supported Puppet version is 4.10.0 and that the data is compatible with [hiera
5](https://puppet.com/docs/puppet/5.3/hiera_migrate.html#use-cases-for-upgrading-to-hiera-5)
* 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](https://puppet.com/docs/puppet/latest/lang_template_epp.html), not
[erb](https://puppet.com/docs/puppet/latest/lang_template_erb.html)
* Is a new class added? It should have unit tests using
[rpsec-puppet-facts](https://github.com/mcanevet/rspec-puppet-facts#rspec-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](http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_206),
and some tools don't handle the lack of a terminating newline properly
* The parameter section should always be aligned at the `=` char
* Is a class considered private? Then it should contain [assert_private](https://github.com/puppetlabs/puppetlabs-stdlib#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](https://github.com/puppetlabs/beaker-module_install_helper#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](https://puppet.com/docs/puppet/5.5/style_guide.html#dependencies)
* 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.
* Is a class considered private? Then it should contain
[assert_private](https://github.com/puppetlabs/puppetlabs-stdlib#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](https://github.com/puppetlabs/beaker-module_install_helper#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](https://puppet.com/docs/puppet/5.5/style_guide.html#dependencies)
* 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.


### Approving and Merging

* You can merge your own PR if it was approved by someone else 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](https://github.com/voxpupuli/modulesync_config#modulesync-configs)). 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](https://github.com/voxpupuli/modulesync_config#modulesync-configs) were reviewed and tested
* 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 can merge your own PR if it was approved by someone else 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](https://github.com/voxpupuli/modulesync_config#modulesync-configs)).
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](https://github.com/voxpupuli/modulesync_config#modulesync-configs)
were reviewed and tested
* 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

## Project management committee

We defined a [governance document](https://github.com/voxpupuli/plumbing/blob/master/share/governance.md#vox-pupuli-governance)
some time ago. It defines several different groups and roles. One of them is
the PMC. For 2019 [we
elected](https://voxpupuli.org/blog/2018/12/19/election-results-2019/) 5
people.
We defined a [governance
document](https://github.com/voxpupuli/plumbing/blob/master/share/governance.md#vox-pupuli-governance)
some time ago. It defines several different groups and roles. One of them is the
PMC. For 2019 [we
elected](https://voxpupuli.org/blog/2018/12/19/election-results-2019/) 5 people.

0 comments on commit b2af595

Please sign in to comment.