-
Notifications
You must be signed in to change notification settings - Fork 0
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 🌴 #2
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bors r+ |
bors bot
added a commit
that referenced
this pull request
May 24, 2018
2: Add Greenkeeper badge 🌴 r=jniles a=greenkeeper[bot] Let’s get started with automated dependency management for Tree 💪⚠️ Greenkeeper has found a `yarn.lock` file in this repository. Please use [greenkeeper-lockfile](https://github.com/greenkeeperio/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 👍 --- <details> <summary>🏷 How to check the status of this repository</summary> 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](https://badges.greenkeeper.io/IMA-WorldHealth/Tree.svg) </details> <details> <summary>🙈 How to ignore certain dependencies</summary> 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](https://github.com/IMA-WorldHealth/Tree/edit/greenkeeper/initial/package.json). 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. ```js // package.json { … "greenkeeper": { "ignore": [ "package-names", "you-want-me-to-ignore" ] } } ``` </details> <details> <summary>👩💻 How to update this pull request</summary> ```bash # 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 ``` </details> <details> <summary>✨ How do dependency updates work with Greenkeeper?</summary> 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. ```diff - "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 ](https://docs.npmjs.com/misc/semver#ranges). 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. ```diff - "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 To get a better idea of which ranges apply to which releases, check out the extremely useful [semver calculator](https://semver.npmjs.com/) provided by npm. </details> <details> <summary>FAQ and help</summary> There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new). </details> --- Good luck with your project and see you soon ✨ Your [Greenkeeper](https://greenkeeper.io) bot 🌴 Co-authored-by: greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com>
Build succeeded |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Let’s get started with automated dependency management for Tree 💪
yarn.lock
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 👉
🙈 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 yourpackage.json
, containing a list of dependencies you don’t want to update.👩💻 How to update this pull request
✨ 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.
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.
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
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 🌴