https://github.com/codebytere/gist-audit-maker

track and update Node audit log gists
https://github.com/codebytere/gist-audit-maker

Last synced: 15 days ago
JSON representation

track and update Node audit log gists

• Host: GitHub
• URL: https://github.com/codebytere/gist-audit-maker
• Owner: codebytere
• Created: 2019-01-09T03:10:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-04-28T18:49:00.000Z (over 2 years ago)
• Last Synced: 2024-10-09T11:41:27.086Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 628 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Gist Audit Maker

In keeping track of commits that need auditing for backport in Node.js, the current best approach is to maintain and update a gist with the commits.

This package allows for automatic updating of this gist.

### To Use

Set the following environment variables, as these are needed to authenticate `@octokit/rest` for gist fetching and updating

```sh

export USERNAME=

export PASSWORD=

```

This tool will look for a file named according to the following format: `audit-v[VERSION]-[SEMVER].md`, where version is a Node version such as `audit-v10-patch.md` or `audit-v11-minor.md`. If a gist with this name pattern doesn't exist, this tool will create it for you and then update it on future runs.

Install `gist-audit-maker` globally:

```sh

$ npm i -g gist-audit-maker

```

This tool must be run from your local clone of the core `nodejs/node` repository. It takes three arguments:

1. `branch` - the target branch for auditing

2. `semver` - whether you would like to see either `semver-minor` or `semver-patch` commits (possible values are `minor` or `patch`)

3. `fork` - whether or not the repo in which this is being run is a fork (defaults to `false`)

Examples:

```sh

$ cd /path/to/node

$ gist-audit-maker --branch=v10.x --semver=patch --fork=true

```

```sh

$ cd /path/to/node

$ gist-audit-maker --branch=v11.x --semver=minor

```

You could also run it with `npx`, like so:

```sh

$ cd /path/to/node

$ npx gist-audit-maker --branch=v10.x --semver=minor --fork=false

```