Merge pull request #1798 from apiraino/rename-gh-token-env-var

Rename GitHub token env var

Author: jackh726

.env.sample

@@ -1,5 +1,5 @@
-# if `GITHUB_API_TOKEN` is not set here, the token can also be stored in `~/.gitconfig`
-GITHUB_API_TOKEN=MUST_BE_CONFIGURED
+# if `GITHUB_TOKEN` is not set here, the token can also be stored in `~/.gitconfig`
+GITHUB_TOKEN=MUST_BE_CONFIGURED
 DATABASE_URL=MUST_BE_CONFIGURED
 GITHUB_WEBHOOK_SECRET=MUST_BE_CONFIGURED
 # for logging, refer to this document: https://rust-lang-nursery.github.io/rust-cookbook/development_tools/debugging/config_log.html
@@ -8,6 +8,6 @@ GITHUB_WEBHOOK_SECRET=MUST_BE_CONFIGURED
 
 # If you are running a bot on non-rustbot account,
 # this allows to configure that username which the bot will respond to.
-# For example write blahblahblah here, if you want for this bot to 
+# For example write blahblahblah here, if you want for this bot to
 # respond to @blahblahblah claim.
 # TRIAGEBOT_USERNAME=CAN_BE_CONFIGURED

README.md

@@ -40,7 +40,7 @@ The general overview of what you will need to do:
 4. Configure the `.env` file:
 
    1. Copy `.env.sample` to `.env`
-   2. `GITHUB_API_TOKEN`: This is a token needed for Triagebot to send requests to GitHub. Go to GitHub Settings > Developer Settings > Personal Access Token, and create a new token. The `repo` permission should be sufficient.
+   2. `GITHUB_TOKEN`: This is a token needed for Triagebot to send requests to GitHub. Go to GitHub Settings > Developer Settings > Personal Access Token, and create a new token. The `repo` permission should be sufficient.
       If this is not set, Triagebot will also look in `~/.gitconfig` in the `github.oauth-token` setting.
    3. `DATABASE_URL`: This is the URL to the database. See [Configuring a database](#configuring-a-database).
    4. `GITHUB_WEBHOOK_SECRET`: Enter the secret you entered in the webhook above.

src/github.rs

@@ -2035,6 +2035,12 @@ impl RequestSend for RequestBuilder {
 /// Finds the token in the user's environment, panicking if no suitable token
 /// can be found.
 pub fn default_token_from_env() -> String {
+    match std::env::var("GITHUB_TOKEN") {
+        Ok(v) => return v,
+        Err(_) => (),
+    }
+
+    // kept for retrocompatibility but usage is discouraged and will be deprecated
     match std::env::var("GITHUB_API_TOKEN") {
         Ok(v) => return v,
         Err(_) => (),
@@ -2045,7 +2051,7 @@ pub fn default_token_from_env() -> String {
         Err(_) => (),
     }
 
-    panic!("could not find token in GITHUB_API_TOKEN or .gitconfig/github.oath-token")
+    panic!("could not find token in GITHUB_TOKEN, GITHUB_API_TOKEN or .gitconfig/github.oath-token")
 }
 
 fn get_token_from_git_config() -> anyhow::Result<String> {