Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

renovate-config-algolia

2.1.3 • Public • Published

renovate-config-algolia

This repository holds a shareable configuration, much like algolia/eslint-config-algolia.

Renovate keeps npm dependencies up-to-date. The right way, the right features and right time.

Table of Contents generated with DocToc

How to use it

1. Create a renovate.json file:

If you have a JavaScript application (dashboard, static website generator), put in renovate.json:

{
  "extends": ["config:js-app", "algolia"]
}

If you have a JavaScript library:

{
  "extends": ["config:js-lib", "algolia"]
}

The only difference between the two configuration is that, an application, will have devDependencies AND dependencies pinned. While a JavaScript library will only have devDependencies pinned.

There's no need to install renovate-config-algolia, it's automatically picked up by renovate for now.

Read more about dependencies pinning.

2. Activate renovate

Go to https://github.com/apps/renovate, ask a GitHub admin of the organisation if you need help on how to do this step.

What's inside the configuration?

This configuration is made to automerge any minor and patch updates to any dependencies in your repository. It will directly push to the GitHub default branch of your project.

It runs every weekend, Paris time.

We choosed to have a configuration that directly push to GitHub to avoid any notification noise inside GitHub by having a lot of Pull Requests to merge manually. If the update passes your test suite, then it's merged directly. If tests are not passing or if there's a major upgrade then a pull request will be opened.

Requirements

You can't use protected branch features along with this configuration. This is currently a limitation from GitHub.

If protected branches are activated on your repository, disable them (settings).

Releasing

# change package.json 
git commmit -am 'feat(renovate): more goodness'
npm run release

Keywords

none

Install

npm i renovate-config-algolia

DownloadsWeekly Downloads

2

Version

2.1.3

License

MIT

Unpacked Size

70.5 kB

Total Files

5

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar