kolyaventuri/chaos-mod-gh-bot

GH comment bot for the GTA V Chaos Mod

Chaos Mod Repo bot

Issue bot for the GTA V Chaos Mod

Overview

Handles posting issue comments to inform users of when their effect / feature / bug report might have an issue, or does not follow a template. ex:

Stack

• Framework
  • Serverless
• Testing
  • AVA (test runner)
  • XO (code linting)

How to use

1. npm i to get the dependencies installed
2. Run the local build with npm run serve! (alternatively serve:watch will run with nodemon)

IAM Setup

You will need a properly configured IAM user, role, and policy in order to deploy.

1. Generate a valid IAM policy with npm run generate-policy -- --stage={{STAGE}} where {{STAGE}} is your deployment stage, typically production or dev (default dev). Configure this as a new IAM policy.
2. Create a role for your deployment stage, that matches your AWS_ROLE entry in the .env, plus prefix. For example, if you set AWS_ROLE=chaos-bot, for production, create a chaos-bot-production role
3. Repeat step 2 for your AWS_PROFILE, creating an IAM user with your chosen profile, plus suffix. I.e., AWS_PROFILE=chaos.would be chaos-production for production deployments. Remember to save your access key and secret to your ~/.aws/credentials file.
4. Attach your IAM policy from step 1 to your role and your profile if not already done.

Deploying

1. Set your profile, role, aws id, and github token in a .env file (note: role is minus the environment. See step 2 of IAM setup)
2. Run npm run deploy to deploy to a dev stage, or npm run deploy:production to deploy to production.

Q + A

Why AVA? Why not Jest?

• Personal preference. I find Jest clunky in comparison, but it has its merits. Feel free to swap it out.

Why use such a strict linter?

• I like clean code, and personally it forces me to write more readable code. The style is automagically enforced by Prettier anyways.