Merge pull request #2055 from timbrel/env-vars

Author: kaste

GitSavvy.sublime-settings

@@ -42,9 +42,15 @@
     "users_home": "~",
 
     /*
-        Enter your github API key in the field below.  To interact with
-        a GitHub Enterprise instance, add a field with the FQDN as the key
-        and the API key as the value.
+        Enter your GitHub/GitLab API key(s) in the field below.
+        To interact with enterprise/self-hosted instances, add a field with
+        the FQDN as the key and the API key as the value.
+
+        Alternatively, you can set environment variables as fallback:
+        - GITHUB_TOKEN (for GitHub)
+        - GITLAB_TOKEN (for GitLab)
+
+        Per-host keys in `api_tokens` take precedence over env vars.
      */
     "api_tokens": {
         // "github.com": "ADD YOUR GITHUB TOKEN HERE"

docs/github.md

@@ -11,6 +11,7 @@ When interacting with a public repository, no configuration is required.  Howeve
 2. After submitting, copy the generated API key.
 3. In the Sublime Menu, open `Preferences > Package Settings > GitSavvy > Settings - User`.
 4. Add your key to the `api_tokens` object (you can find an example in `Preferences > Package Settings > GitSavvy > Settings`).
+5. Alternatively, set the `GITHUB_TOKEN` environment variable. GitSavvy uses it as a fallback when no token is configured for the remote in `api_tokens`.
 
 
 ## Choosing a remote

docs/gitlab.md

@@ -11,6 +11,7 @@ When interacting with a public repository, no configuration is required.  Howeve
 2. After submitting, copy the generated API key.
 3. In the Sublime Menu, open `Preferences > Package Settings > GitSavvy > Settings - User`.
 4. Add your key to the `api_tokens` object (you can find an example in `Preferences > Package Settings > GitSavvy > Settings`).
+5. Alternatively, set the `GITLAB_TOKEN` environment variable. GitSavvy uses it as a fallback when no token is configured for the remote in `api_tokens`.
 
 
 ## Choosing a remote

github/commands/create_repo.py

@@ -32,9 +32,11 @@ def on_done(name: str) -> None:
 
 def get_github_user_token(cmd: GsCommand, args: Args, done: Kont) -> None:
     fqdn = "github.com"
-    token = cmd.savvy_settings.get("api_tokens", {}).get(fqdn)
+    token = cmd.savvy_settings.get("api_tokens", {}).get(fqdn) or os.environ.get("GITHUB_TOKEN")
     if not token:
-        cmd.window.status_message(f"Abort, no API token found in the settings for {fqdn}.")
+        cmd.window.status_message(
+            f"Abort, no API token found in settings for {fqdn} or env var GITHUB_TOKEN."
+        )
         return
     done(token)
 

github/github.py

@@ -3,6 +3,7 @@
 """
 
 from __future__ import annotations
+import os
 import re
 from webbrowser import open as open_in_browser
 from functools import partial
@@ -29,7 +30,7 @@ class GitHubRepo(NamedTuple):
     fqdn: str
     owner: str
     repo: str
-    token: str
+    token: str | None
 
 
 def remote_to_url(remote_url: str) -> str:
@@ -72,7 +73,7 @@ def parse_remote(remote_url: str) -> GitHubRepo:
         raise ValueError("Invalid github url: {}".format(url))
 
     fqdn, owner, repo = match.groups()
-    token = GitSavvySettings().get("api_tokens", {}).get(fqdn)
+    token = GitSavvySettings().get("api_tokens", {}).get(fqdn) or os.environ.get("GITHUB_TOKEN")
     return GitHubRepo(url, fqdn, owner, repo, token)
 
 

gitlab/gitlab.py

@@ -2,6 +2,7 @@
 GitLab methods that are functionally separate from anything Sublime-related.
 """
 
+import os
 import re
 from collections import namedtuple
 from functools import partial, lru_cache
@@ -72,7 +73,7 @@ def parse_remote(remote):
         return None
 
     fqdn, owner, repo = match.groups()
-    token = GitSavvySettings().get("api_tokens", {}).get(fqdn)
+    token = GitSavvySettings().get("api_tokens", {}).get(fqdn) or os.environ.get("GITLAB_TOKEN")
     return GitLabRepo(url, fqdn, owner, repo, token)