diff --git a/.github/supersetbot/.eslintrc.json b/.github/supersetbot/.eslintrc.json new file mode 100644 index 0000000000000..22f0d26d28384 --- /dev/null +++ b/.github/supersetbot/.eslintrc.json @@ -0,0 +1,22 @@ +{ + "extends": "airbnb-base", + "rules": { + "import/extensions": 0, + "import/prefer-default-export": 0, + "func-names": 0, + "no-console": 0, + "class-methods-use-this": 0 + }, + "parserOptions": { + "ecmaVersion": 2020, + "sourceType": "module" + }, + "parserOptions": { + "ecmaVersion": "latest", + "sourceType": "module", + "requireConfigFile": false + }, + "env": { + "jest": true + } +} diff --git a/.github/supersetbot/README.md b/.github/supersetbot/README.md new file mode 100644 index 0000000000000..4042e985ce3fc --- /dev/null +++ b/.github/supersetbot/README.md @@ -0,0 +1,37 @@ +# 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 + +```bash +$ use nvm 20 +$ npm i -g supersetbot +$ supersetbot +Usage: supersetbot [options] [command] + +Options: + -v, --verbose Output extra debugging information + -r, --repo The GitHub repo to use (ie: "apache/superset") + -d, --dry-run Run the command in dry-run mode + -a, --actor The actor + -h, --help display help for command + +Commands: + label [options]