@opentr/cuttlecat v0.0.10

CuttleCat - Collect information from GitHub

TODO: Project description, purpose, etc.

Building the project

# switch to the correct node version in .nvrmc
nvm use
# install dependencies
npm install
# build the project
npm run build

Usage

PROCESS=<process name> \
OTHER_PARAMETERS=... \
npm run start

PROCESS can be one of the following:

• FOCUS_PROJECT_SEARCH - search for projects that match the criteria

Process FOCUS_PROJECT_SEARCH

Supports the following environment variables:

The options marked as Yes in the Persisted column are persisted in the process state file. This means, when the process is run again for the same process file again later, it will use the values from the file. This is to continue a search process. Those values will only be used if there's a new process file created.

The options marked as No in the Persisted column will always be used from the environment variables.

The output will be written to the ./data/focus-project-search directory.

To start the process with defaults:

# store the results in a temporary directory
mkdir -p /tmp/foo/bar

GITHUB_TOKEN="$(gh auth token)" \
DATA_DIRECTORY="/tmp/foo/bar" \
PROCESS="FOCUS_PROJECT_SEARCH" \
MIN_AGE_IN_DAYS=5700 \
npm run start

Running tests

npm run test

Testing GitHub Actions workflows locally

Test publish release

  act --job=publish-release-on-npm \
  -s GITHUB_TOKEN="$(gh auth token)" \
  -s NPM_TOKEN="FAKE TOKEN" \
  --reuse=true \
  --use-gitignore=true \
  --remote-name=origin

Test publish snapshot

  act --job=publish-snapshot-on-npm \
  -s GITHUB_TOKEN="$(gh auth token)" \
  -s NPM_TOKEN="FAKE TOKEN" \
  --reuse=true \
  --use-gitignore=true \
  --remote-name=origin