History

TechAuditBI 6db94e98b5 other: Add TechAuditBI to supersetbot metadata.js (#27634 )		2024-03-27 12:19:11 -04:00
..
src	other: Add TechAuditBI to supersetbot metadata.js (#27634 )	2024-03-27 12:19:11 -04:00
.eslintrc.json	feat(supersetbot): introduce `supersetbot` as its own npm package, CLI and comment-operated bot (#27046 )	2024-03-13 16:26:48 -07:00
README.md	feat(supersetbot): introduce `supersetbot` as its own npm package, CLI and comment-operated bot (#27046 )	2024-03-13 16:26:48 -07:00
jest.config.js	feat(supersetbot): introduce `supersetbot` as its own npm package, CLI and comment-operated bot (#27046 )	2024-03-13 16:26:48 -07:00
package-lock.json	feat(supersetbot): introduce `supersetbot` as its own npm package, CLI and comment-operated bot (#27046 )	2024-03-13 16:26:48 -07:00
package.json	fix(docker): error around missing requirements/base.txt (#27608 )	2024-03-21 12:22:57 -07:00

README.md

supersetbot

supersetbot is a utility bot that can be used to help around GitHub, CI and beyond.

The bot can be used as a local CLI OR, for a subset of fitted use cases, can be invoked directly from GitHub comments.

Because it's its own npm app, it can be tested/deployed/used in isolation from the rest of Superset, and take on some of the complexity from GitHub actions and onto a nifty utility that can be used in different contexts.

Features

$ use nvm 20
$ npm i -g supersetbot
$ supersetbot
Usage: supersetbot [options] [command]

Options:
  -v, --verbose                      Output extra debugging information
  -r, --repo <repo>                  The GitHub repo to use (ie: "apache/superset")
  -d, --dry-run                      Run the command in dry-run mode
  -a, --actor <actor>                The actor
  -h, --help                         display help for command

Commands:
  label [options] <label>            Add a label to an issue or PR
  unlabel [options] <label>          Remove a label from an issue or PR
  release-label-pr [options] <prId>  Figure out first release for PR and label it
  version                            Prints supersetbot's version number
  release-label-prs [options]        Given a set of PRs, auto-release label them
  release-label [options] <release>  Figure out first release for PR and label it
  orglabel [options]                 Add an org label based on the author
  docker [options]                   Generates/run docker build commands use in CI
  help [command]                     display help for command