Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Add Greenkeeper badge 🌴 #17

Merged
merged 3 commits into from
Aug 14, 2017
Merged

Add Greenkeeper badge 🌴 #17

merged 3 commits into from
Aug 14, 2017

Conversation

greenkeeper[bot]
Copy link
Contributor

@greenkeeper greenkeeper bot commented Aug 14, 2017

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

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


🏷 How to check the status of this repository

There is a badge added to your README, indicating the status of this repository.

This is how your badge looks like 👉 Greenkeeper badge

🏗 How to configure Travis CI

There is a rule added to your .travis.yml file as well. It whitelists Greenkeeper branches, which are created when your dependencies are updated. Travis CI will run your tests to see if they still pass.

No additional setup required 😊

🙈 How to ignore certain dependencies

In case you can not, or do not want to update a certain dependency right now, you can of course just change the package.json file back to your liking.

Add a greenkeeper.ignore field to your package.json, containing a list of dependencies you don’t want to update right now.

// package.json
{
  
  "greenkeeper": {
    "ignore": [
      "package-names",
      "you-want-me-to-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, so it’s working again
  git commit -m 'chore: adapt code to updated dependencies'
  git push origin greenkeeper/initial
✨ How the updates will look like

As soon as you merge this pull request I’ll create a branch for every dependency update, with the new version applied. The branch creation should trigger your testing services to check the new version. Using the results of these tests I’ll 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"

In the above example you can see 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 I’ll delete the branch again, because no action needs to be taken – everything is fine.
When there is a failure however, I’ll create an issue so you know about the problem immediately.

This way every single version update of your dependencies will either continue to work with your project, or you’ll get to know of potential problems immediately.

-  "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.

Now you no longer need to check for exciting new versions by hand – I’ll just let you know automatically.
And the pull request will not only serve as a reminder to update. In case it passes your decent test suite that’s a strong reason to merge right away :shipit:

💁‍♂️ Not sure how things are going to work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.


Good luck with your project and see you soon ✨

Your Greenkeeper Bot 🌴

@greenkeeper greenkeeper bot added the dependencies Pull requests that update a dependency file label Aug 14, 2017
move gk badge
@ralphtheninja ralphtheninja self-assigned this Aug 14, 2017
@ralphtheninja ralphtheninja merged commit d52cf70 into master Aug 14, 2017
@ralphtheninja ralphtheninja deleted the greenkeeper/initial branch August 14, 2017 15:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant