Skip to content
Snippets Groups Projects
Commit 0cf7aa91 authored by Rhys Arkins's avatar Rhys Arkins Committed by GitHub
Browse files

Update README.md

parent 05b9fd51
No related branches found
No related tags found
No related merge requests found
# renovate # renovate
Keeping npm dependencies up-to-date. Keep npm dependencies up-to-date.
## Before you Start ## Before you Start
To run this script, you will need to select a GitHub account for it to use. The account will need read/write access to push and update upgrade branches to GitHub, as well as raise Pull Requests. To run this script, you will need to select a GitHub account for it to use. The account will need read/write access to push and update upgrade branches to GitHub, as well as raise Pull Requests.
We recommend to use a named "bot" account so that it's clear to other users of the repository that these are automated actions and not a team member performing them all manually. We recommend using a "bot" account so that it's clear to other users of the repository that these are automated actions and not a team member performing them all manually.
### GitHub SSH access for git The script will need a GitHub "access token" for authenticating API access. You can find instructions for generating it here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
This script performs git clones, branching and pushing of branches to GitHub using SSH-based authentication. The public key (`~/.ssh/id_rsa.pub`) of wherever you're running the script needs to be manually added to GitHub before the first time you run the script. You can find instructions here: https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/ This token needs to be exposed via the environment variable `RENOVATE_TOKEN`.
### Personal Access Token for GitHub API access
The script will also need a GitHub "access token" for authenticating API access. You can find instructions for generating it here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/
## Running the Script ## Running the Script
...@@ -25,7 +21,7 @@ First, install dependencies for this script by running `npm install`. ...@@ -25,7 +21,7 @@ First, install dependencies for this script by running `npm install`.
The script can then be run like this: The script can then be run like this:
```sh ```sh
node src/index.js <github token> <username>/<repo> <path to package.json> node src <username>/<repo> <path to package.json>
``` ```
The `<path to package.json>` argument is optional, and is only needed if your `package.json` is located somewhere other than the root of the repository. The `<path to package.json>` argument is optional, and is only needed if your `package.json` is located somewhere other than the root of the repository.
...@@ -33,11 +29,17 @@ The `<path to package.json>` argument is optional, and is only needed if your `p ...@@ -33,11 +29,17 @@ The `<path to package.json>` argument is optional, and is only needed if your `p
Example of running with default `package.json` location: Example of running with default `package.json` location:
```sh ```sh
node src/index.js JDSUW284HSJDSFKSUS22942H2H15KK singapore/renovate node src singapore/renovate
``` ```
Example of running with a custom `package.json` location: Example of running with a custom `package.json` location:
```sh ```sh
node src/index.js JDSUW284HSJDSFKSUS22942H2H15KK singapore/renovate containers/build/package.json node src JDSUW284HSJDSFKSUS22942H2H15KK singapore/renovate containers/build/package.json
```
Note: as mentioned above, you need to expose the environment variable `RENOVATE_TOKEN`. One way of doing it is like this:
```sh
RENOVATE_TOKEN=JDSUW284HSJDSFKSUS22942H2H15KK node src singpaore/renovate
``` ```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment