dotmh / dyn-o-might

A Light weight wrapper for Dynamo DB functions.
Apache License 2.0
1 stars 0 forks source link

Add badge to enable Greenkeeper 🌴 #20

Closed greenkeeper[bot] closed 5 years ago

greenkeeper[bot] commented 5 years ago

Let’s get started with automated dependency management for dyn-o-might :muscle:

🔒 Greenkeeper has found a package-lock.json file 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 only adds the Greenkeeper badge to your readme file, since all of the dependencies were already up to date. 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.

💸 Warning 💸 Enabling Greenkeeper on this repository by merging this pull request might increase your monthly payment. If you’re unsure, please check your billing status.


📦 How to enable private scoped packages Public scoped packages (`@scope/name`) work out of the box, but private scoped packages require an additional setup step in which you tell npm to alert Greenkeeper every time the package or scope you specify is updated. This step only needs to be run once per Greenkeeper _installation_, meaning once per GitHub organisation or user account. You will need to run it again if you ever remove and re-add the Greenkeeper installation on org or user account level, but _not_ if you’re just adding, removing or resetting repositories. - These commands can be run on your local machine - You must be authenticated for the npm registry in the terminal session you’re using (see [npm login](https://docs.npmjs.com/creating-a-new-npm-user-account#testing-your-new-account-with-npm-login)) - This is a one-time operation, once you’ve registered the hook with npm, Greenkeeper will get updates until you tell npm to stop sending them, or you uninstall Greenkeeper on your org or user account. - ⚠️ Make sure you replace the placeholders below with the actual values you need: - `SCOPED_PACKAGE_NAME`: A full scoped package name, such as `@megacorp/widget` - `SCOPE_NAME`: Just the scope name: `@megacorp` - `OWNER_NAME`: An npm username: `substack` ```bash # Some of the things you can do with npm hooks: # Add a single private scoped package npm hook add SCOPED_PACKAGE_NAME https://hooks.greenkeeper.io/npm/36915 021f6368a310f673487ad8c2052e35ccfc06635aadbabce8746c82becb5458cf # Add all private packages in a scope npm hook add SCOPE_NAME https://hooks.greenkeeper.io/npm/36915 021f6368a310f673487ad8c2052e35ccfc06635aadbabce8746c82becb5458cf # Add all private packages by a specific owner npm hook add --type owner OWNER_NAME https://hooks.greenkeeper.io/npm/36915 021f6368a310f673487ad8c2052e35ccfc06635aadbabce8746c82becb5458cf ``` For additional options and information, please consult the [npm CLI docs]( https://docs.npmjs.com/cli/hook.html). If you are using npm version 5 or below, you need a separate tool called wombat to do this. Globally install wombat via npm and then use the same commands as above, but with `wombat` instead of `npm`. More in the [Wombat docs](https://www.npmjs.com/package/wombat).
🏷 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 :point_right: ![Greenkeeper badge](https://badges.greenkeeper.io/dotmh/dyn-o-might.svg?token=df0c7c3f1a9ddef01b0b07a1d49c6df06337f9c0864d118fd184287724f5c1b8&ts=1568120907264)
🙈 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](https://github.com/dotmh/dyn-o-might/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" ] } } ```
👩‍💻 How to update this pull request ```bash # Change into your repository’s directory git fetch --all 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 https://github.com/dotmh/dyn-o-might.git 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. ```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 :shipit: 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.
FAQ and help 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).

Good luck with your project and see you soon :sparkles:

Your Greenkeeper bot :palm_tree: