Skip to content
This repository has been archived by the owner on Jan 16, 2024. It is now read-only.

Latest commit

 

History

History
103 lines (67 loc) · 4.37 KB

CONTRIBUTING.md

File metadata and controls

103 lines (67 loc) · 4.37 KB
Raw

mscbot

Travis

ToC

Development

Chat

There is an #rfcbot channel in the ops section of the rust-lang discord server.

Rust Version

Rust nightly is required, as rfcbot uses Rocket. If you use rustup, this version is controlled by a rust-toolchain file at the repository root.

Heroku CLI

https://devcenter.heroku.com/articles/heroku-cli

Environment variables

See config.rs for the environment variables expected. Also, rocket env vars are supported.

Running server processes

There are two daemons to run, one for the front-end development server, and one for the back-end API server and scraper. It's recommended to run these in two separate terminal windows/tabs/sessions.

You may need to run database migrations if the bootstrap SQL file is stale:

$ diesel migration run

To run the back-end API server and scraper:

$ cargo run

NOTE: The API server process needs to be manually restarted whenever you want to see code changes reflected in their behavior, or whenever you run migrations on the test database. A Ctrl+C followed by Up and Enter usually works if running them through cargo. cargo watch is also a nice tool.

Database connection

If you want to perform any database action, make sure you have a reachable installation of PostgreSQL that is configured with the DATABASE_URL environment variable.

Configuration

Environment variables

Note that you can configure the Rocket web server using environment variables like ROCKET_PORT, according to the Rocket configuration guide.

  • DATABASE_URL: postgres database URL
  • DATABASE_POOL_SIZE: number of connections to maintain in the pool
  • GITHUB_ACCESS_TOKEN: your access token from GitHub. See this page for more information. You shouldn't need to check any of the boxes for granting scopes when creating it.
  • GITHUB_USER_AGENT: the UA string to send to GitHub (they request that you send your GitHub username or the app name you registered for the client ID)
  • GITHUB_WEBHOOK_SECRETS: a comma-delimited string of the secrets used for any ingestion webhooks. The webhook handler will attempt to validate any POST'd webhook against each secret until it either finds a matching one or runs out.
  • RUST_LOG: the logging configuration for env_logger. If you're unfamiliar, you can read about it in the documentation linked on crates.io. If it's not defined, logging will default to info!() and above.
  • GITHUB_SCRAPE_INTERVAL: time (in minutes) to wait in between GitHub scrapes
  • POST_COMMENTS: whether to post RFC bot comments on issues -- either true or false. Be very careful setting to true when testing -- it will post comments using whatever account is associated with the GitHub API key you provide.

Database

PostgreSQL 9.5+ is recommended. To init, make sure DATABASE_URL is set.

cargo install diesel_cli
diesel migration run

That should have the database you've specified ready to receive data. Then you can run some of the bootstrapping commands (see below). Alternatively, you can use bootstrap.sql to get a nice starting point for the database (note that this isn't maintained regularly).

psql -d $DB_NAME_HERE -f bootstrap.sql

Deployment

Deployed to Heroku via TravisCI from the master branch.

Conduct

This project has a Code of Conduct and moderation policy very similar to the Rust CoC.

License

This project is distributed under the terms of both the MIT license and the Apache License (Version 2.0). See LICENSE-MIT and LICENSE-APACHE for details.