Skip to content
This repository has been archived by the owner on Jun 22, 2020. It is now read-only.

Update dependencies to enable Greenkeeper 🌴 #1

Merged
merged 6 commits into from
Feb 6, 2018

Conversation

greenkeeper[bot]
Copy link
Contributor

@greenkeeper greenkeeper bot commented Feb 6, 2018

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

⚠️ Greenkeeper has found a yarn.lock file in this repository. Please use greenkeeper-lockfile to make sure this gets 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.


🏷 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": [
      "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 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 🌴

@codecov
Copy link

codecov bot commented Feb 6, 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   53.33%   53.33%           
=======================================
  Files           1        1           
  Lines          15       15           
  Branches        2        2           
=======================================
  Hits            8        8           
  Misses          7        7

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 79dd600...69b2aab. Read the comment docs.

@mattyclarkson mattyclarkson force-pushed the greenkeeper/initial branch 2 times, most recently from fe84f86 to 0f7e2ad Compare February 6, 2018 15:53
@mattyclarkson mattyclarkson merged commit 7e19a57 into master Feb 6, 2018
@mattyclarkson mattyclarkson deleted the greenkeeper/initial branch February 6, 2018 16:25
mattyclarkson added a commit that referenced this pull request Feb 7, 2018
We need to be able to re-map the TypeScript declaration files as well as the generated ECMAscript
output files. This will require almost exactly the same process as the ECMAscript re-mapping. The
classes that handle the re-mapping have been made generic so that we can re-use the same framework
for the declaration re-mapping. See #1

BREAKING CHANGE: The re-mapping classes have been made generic and there are ES derived variants of
each. This is required so that we can nicely re-map TypeScript declaration files using the same
re-mapping framework. The demo library code in the `README` will still work, however, the modules
have all moved around hence the breaking change 💥 If you do not do any module loading of the
library, then you will require no code changes other than upgrading your dependency
mattyclarkson added a commit that referenced this pull request Feb 7, 2018
Adds the necessary derived classes to map the paths in the generated TypeScript declaration files.

fixes #1
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

Successfully merging this pull request may close these issues.

1 participant