Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up
Let’s get started with automated dependency management for feathers💪
package-lock.jsonfile 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.This pull request updates all your dependencies to their latest version. Having them all up to date really is the best starting point for keeping up with new releases. Greenkeeper will look out for further dependency updates and make sure to handle them in isolation and in real-time, but only after you merge this pull request.
Important: Greenkeeper will only start watching this repository’s dependency updates after you merge this initial pull request.
package.jsonfiles. Since this repo already has agreenkeeper.jsonconfig file with defined groups, Greenkeeper has only checked whether they’re still valid.Greenkeeper has added a rule to your
.travis.ymlthat whitelists Greenkeeper branches, which are created when your dependencies are updated. Travis CI will run your tests on these branches automatically to see if they still pass.No additional setup is required😊
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.jsonfile back to whatever you prefer.To make sure Greenkeeper doesn’t nag you again on the next update, add a
greenkeeper.ignorefield to yourpackage.json, containing a list of dependencies you don’t want to update.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.
The above example shows an in-range update.
1.7.0is included in the old^1.6.0range, 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.
In this example, the new version
4.0.0is not included in the old^3.0.0range.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
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🌴