Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Greenkeeper badge 🌴 #912

merged 2 commits into from Apr 9, 2019


None yet
1 participant
Copy link

commented Apr 9, 2019

Let’s get started with automated dependency management for misk 💪

🔒 Greenkeeper has found a package-lock.json file in this repository. Greenkeeper supports lockfile updates for public packages. If you use private packages in your repository, please use greenkeeper-lockfile to make sure these can get updated as well.

All of your dependencies are already up-to-date, so this repository was enabled right away. Good job 👍

📦 📦 Greenkeeper has detected multiple package.json files. They have all been added to a new greenkeeper.json config file. They’ve been collected in a group called default, meaning that all of them will receive updates together. You can rename, add and remove groups and freely assign each package.json to whichever group you like. It’s common, for example, to have one frontend group and one backend group, each with a couple of package.json files. In any case, all files in a group will have their updates collected into single PRs and issues.

🙈 How to ignore certain dependencies

You may have good reasons for not wanting to update to a certain dependency right now. In this case, you can change the dependency’s version string in the package.json file back to whatever you prefer.

To make sure Greenkeeper doesn’t nag you again on the next update, add a greenkeeper.ignore field to your package.json, containing a list of dependencies you don’t want to update.

// package.json
  "greenkeeper": {
    "ignore": [
👩‍💻 How to update this pull request
  # Change into your repository’s directory
  git fetch --all
  git checkout greenkeeper/initial
  npm install-test
  # Adapt your code until everything works again
  git commit -m 'chore: adapt code to updated dependencies'
  git push greenkeeper/initial
How do dependency updates work with Greenkeeper?

After you merge this pull request, Greenkeeper will create a new branch whenever a dependency is updated, with the new version applied. The branch creation should trigger your testing services and check whether your code still works with the new dependency version. Depending on the the results of these tests Greenkeeper will try to open meaningful and helpful pull requests and issues, so your dependencies remain working and up-to-date.

-  "underscore": "^1.6.0"
+  "underscore": "^1.7.0"

The above example shows an in-range update. 1.7.0 is included in the old ^1.6.0 range, because of the caret ^ character .
When the test services report success Greenkeeper will silently delete the branch again, because no action needs to be taken – everything is fine.

However, should the tests fail, Greenkeeper will create an issue to inform you about the problem immediately.

This way, you’ll never be surprised by a dependency breaking your code. As long as everything still works, Greenkeeper will stay out of your way, and as soon as something goes wrong, you’ll be the first to know.

-  "lodash": "^3.0.0"
+  "lodash": "^4.0.0"

In this example, the new version 4.0.0 is not included in the old ^3.0.0 range.
For version updates like these – let’s call them “out of range” updates – you’ll receive a pull request.

This means that you no longer need to check for new versions manually – Greenkeeper will keep you up to date automatically.

These pull requests not only serve as reminders to update: If you have solid tests and good coverage, and the pull requests passes those tests, you can very likely just merge it and release a new version of your software straight away :shipit:

To get a better idea of which ranges apply to which releases, check out the extremely useful semver calculator provided by npm.

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Good luck with your project and see you soon

Your Greenkeeper bot 🌴

@greenkeeper greenkeeper bot added the greenkeeper label Apr 9, 2019


adrw approved these changes Apr 9, 2019

@adrw adrw merged commit 46adaf7 into master Apr 9, 2019

3 checks passed

ci/circleci: java Your tests passed on CircleCI!
ci/circleci: node Your tests passed on CircleCI!
greenkeeper/verify Greenkeeper verified pull request

@greenkeeper greenkeeper bot deleted the greenkeeper/initial branch Apr 9, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.