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 🌴 #1

merged 1 commit into from Apr 25, 2018


Copy link

greenkeeper bot commented Apr 25, 2018

Let’s get started with automated dependency management for open-source-setup 💪

⚠️ Greenkeeper has found a package-lock.json file in this repository. Please use greenkeeper-lockfile to make sure this gets updated as well.

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

🏷 How to check the status of this repository

Greenkeeper adds a badge to your README which indicates the status of this repository.

This is what your badge looks like right now 👉 Greenkeeper badge

🙈 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
  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 origin 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 25, 2018

This comment has been minimized.

Copy link

codecov-io commented Apr 25, 2018

Codecov Report

Merging #1 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master     #1   +/-   ##
  Coverage     100%   100%           
  Files           1      1           
  Lines           1      1           
  Hits            1      1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f5bb9cb...c010289. Read the comment docs.

@patrickleet patrickleet merged commit 62d0083 into master Apr 25, 2018
5 checks passed
5 checks passed
codecov/patch Coverage not affected when comparing f5bb9cb...c010289
codecov/project 100% remains the same compared to f5bb9cb
continuous-integration/travis-ci/pr The Travis CI build passed
continuous-integration/travis-ci/push The Travis CI build passed
greenkeeper/verify Greenkeeper verified pull request
@greenkeeper greenkeeper bot deleted the greenkeeper/initial branch Apr 25, 2018

This comment has been minimized.

Copy link

patrickleet commented Sep 28, 2018

🎉 This PR is included in version 1.0.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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