Giter Club home page Giter Club logo

babel-bot's Introduction

babel-bot

A bot used by the Babel team to automate common tasks in GitHub repositories. Allows taking action on events triggered from the GitHub webhooks API.

The bot is build as an AWS Lambda function, using AWS API Gateway to map the requests to an endpoint.

Features

  • Create a new comment on newly opened issues (if not in the org)
  • Reply to issue with canned response when Needs Info label is added
  • Notify committer in PR of test failures in TravisCI, and add OS/node.js version that failed, with direct link to log
  • Add Has PR label to issues that have been referenced in a PR
  • Add command to move issues to other repo (@babel-bot move to babel/babylon)
  • Deletes issue comments that are just +1/-1

Future Bot Ideas

Adding a New Event

  1. Look at the list of GitHub webhook events to determine which your rule should respond to.
  2. Find (or create) a folder under src/handlers with the name matching the name of the GitHub event
  3. Create a new JS file under the directory, with the name matching the action or state (dependening on the shape of the GitHub payload) you want your code to be triggered for
  4. Export a default function that accepts 1 argument, which will be the payload from GitHub each time the event is triggered.

Examples of existing event rules can be found in src/handlers.

Setting up AWS Lamdba/API Gateway as a Test Environment

Visit the guide for detailed instructions.

Unit-Testing

Examples of how to test a handler can be seen in src/handlers/issues/__tests__.

Deploying a New Version to AWS Lamdba

This process is currently manual, but will likely be automated in the future.

  1. Run yarn run package, which will create function.zip in the root of the repository
  2. Login to the AWS console, and find the function in the Lambda dashboard, under Functions
  3. Click the Upload button under the Code tab (Code Entry Type should be set to Upload a .ZIP file)
  4. Click Save

If you have a ~/.aws/configuration setup, you can just run npm run deploy.

babel-bot's People

Contributors

aaronang avatar danharper avatar daniel15 avatar dependabot[bot] avatar hzoo avatar jlhwung avatar jridgewell avatar nicolo-ribaudo avatar rajikaimal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

babel-bot's Issues

Automatically deploy babel-bot from master

  • Create IAM credentials with bare minimum amount of access
  • Add credentials to Travis as AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables (ideally in the UI so there's no risk of leakage, but encrypted in travis.yml is OK too)
  • Run ./scripts/deploy.js after building, on commits to master (NOT for PRs)

You might need to adjust deploy.js a bit, I made some assumptions when writing it (region is us-west-1, function name is BabelBot) that might not actually be true.

Auto-Labeling PRs with packages touched in the monorepo

I have a (working) implementation of this done locally, but there are a few decisions we need to make.

  1. Do we have a cutoff (don't label if over X total packages touched)?
  2. Should we not add the label for some use-cases (example: changing only READMEs or package.json)

Input wanted.

Auto label issue with "triage"?

eslintbot added the triage label x days ago

Basically each label starts off with triage and then when someone adds anything else it automatically gets removed?

Maybe not necessary but it might work well if we want it

Reverse Greenkeeper

Send a PR (at least to Babel org projects, and maybe babel plugins) to update to the latest version with a PR, automatically.

  • pr our projects
  • pr canary build (either to either repo as smoke test, or to our own fork)

Nice to Have:

  • Run a codemod if upgrading from 5 to 6, 6 to 7 (if necessary)

Close issue after no response for x days

One option is that we add the awaiting reply label to an issue and if no response after x days we close it.

Or a little differently, we wait x days for the bot to auto comment this will be closed in y days if no response, and if it's a support question ask on slack and not an issue.

Add assignee (reviewer) to PRs

The Facebook/mention-bot offers a programmatic API (source).

It think we could easily integrate it in the Babel-bot.

Usage example:

mentionBot
  .guessOwnersForPullRequest(
    'https://github.com/babel/babel', // repo
    65, // pull request number
    'babel-bot', // user that created the pull request
    'master', // branch
    { maxReviewers: 3 }, // config
    [...]
  )
  .then(function(users) {
    // array with user names which should be included in review
    console.log(users);
  })
  .catch(function(err) {
    console.error(err);
  });

It will be triggered in src/handlers/pull_request/opened.js.

Instead of babel/babel#5057

Can I get more info around setup?

Hi,
In AWS_SETUP.md you have GitHub step that shows how to create new API Token thus giving repo permission. And in the final step, you mention about adding Environment variables such as GITHUB_API_KEY and GITHUB_SECRET from Github step. Where is that defined in Github step? What is API_KEY and SECRET referring to?

Thanks,
Suhas

Core members

If someone is part of the org (or maybe specifically on the core team), add a label to the PR to prioritize! via @jridgewell

Could do something similar for issues

PR Opened: Label if package.json updated

Basically signal that dependencies changed

  • add a package
  • remove a package
  • upgraded a package, etc

similar in idea to #1

basically check the package.json of each folder in packages/x and then would need to parse if it's in devDeps and whether the line was added/removed, changed

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.