greenkeeperkeeper/reference-instance repository overview

⁠reference-instance

an instance of a greenkeeper-keeper service⁠ that can either be deployed as is to your preferred host or used as a reference for creating your own custom instance

⁠Configuration

config for this instance is expected through environment variables and provides the necessary details for the underlying hapi plugin⁠ as well as for ensuring the webhooks are really from GitHub

The required variables are enforced at startup by dotenv-safe⁠ and are defined in .env.example⁠

• PORT: the port that the instance should listen on (might be defined automatically by your host)

• GITHUB_TOKEN: personal access token⁠ for the account intended to accept the greenkeeper PRs

  Note: the personal access token will need the repo and repo:read_hooks scopes in order to work properly

• GITHUB_WEBHOOK_SECRET: a secret used to secure your webhooks⁠ which must match the secret used for the webhook defined for each repo

• ACCEPT_ACTION optional: how the contribution should be integrated⁠, once accepted

⁠Tagging strategy

Since this instance is intended as a reference instance of a hapi⁠ server using the hapi-greenkeeper-keeper⁠ plugin, the instance is versions solely based on the version of the plugin. Each time a new version of the plugin is this repo is tagged with that version.

Keep in mind that other changes could be introduced to this reference instance that do not change the version in a way that is informative related to semver. If you need to manage updates for your server using a different strategy, you are encouraged to include the hapi plugin in your own server instance, using this reference only as a guide for creating your server.

⁠Deployment

⁠Docker

⁠Versioning strategy

Docker tags use the same versioning strategy as is outlined above for git tags. Each git tag results in a tagged image.

⁠Heroku

Since build steps have to happen on the heroku side, ensure that the devDependencies are installed there by setting NPM_CONFIG_PRODUCTION=false

⁠Zeit now