search

gitleaks / gitleaks-action

Protect your secrets using Gitleaks-Action
https://gitleaks.io
Other
332 stars 128 forks source link

Update build instructions #104

Closed ericcornelissen closed 1 year ago

ericcornelissen commented 1 year ago

Followup to https://github.com/gitleaks/gitleaks-action/pull/101#issuecomment-1310501081 - update the quickstart so that one can follow the build instructions on a "clean system" (i.e. one where nvm/Node.js are already installed).

A note on adding @vercel/ncc as a devDependency of this project:

  1. This makes it so you can run the documented command for building if npx is put in front. Note that if a dependency is installed locally (i.e. it's in the node_modules/.bin dir), npx will use that.
  2. This ensures everyone building this action gets the same result.
  3. This avoids having to install ncc globally (which is not always desirable).

Further changes are possible (e.g. creating a build script so you can just run npm run build and abstract the exact build command away and removes the need for invoking npx), but the aim of this Pull Request is to be the minimal set of changes (I could think of) to make the build instructions work.

zricethezav commented 1 year ago

@weineran LGTM! thanks @ericcornelissen!