scripts.md

Scripts

The repository contains a few scripts created to automate routine processes and make it a bit easier to maintain.

For the scripts to work, you must have Node.js installed on your computer.

• act:check
• act:deploy
• act:update
• act:validate_issue
• act:validate_label
• db:validate
• db:export
• db:update
• issue:validate
• lint
• test

act:check

Runs the check workflow locally. Depends on nektos/gh-act.

npm run act:check

act:deploy

Runs the deploy workflow locally. Depends on nektos/gh-act.

npm run act:deploy

act:update

Runs the update workflow locally. Depends on nektos/gh-act.

npm run act:update

act:validate_issue

Runs the validate_issue workflow locally. Depends on nektos/gh-act.

npm run act:validate_issue -- -e .github/mocks/events/issue_opened.json

act:validate_label

Runs the validate_label workflow locally. Depends on nektos/gh-act.

npm run act:validate_label -- -e .github/mocks/events/issue_approved.json --actor Bob

db:validate

Checks all the data in the database for errors.

npm run db:validate

db:export

Creates JSON files with all the data for the iptv-org/api repository.

npm run db:export

db:update

Triggers an update of the database. The process involves processing approved requests from issues.

npm run db:update

issue:validate

Checks the request from the issue for errors and, if any are found, saves them to the file temp/logs/errors.txt.

npm run issue:validate --body "Issue Body" --labels "label1,label2"

lint

Checks the scripts for syntax errors.

npm run lint

test

Runs a test of all the scripts described above.

npm test