GITHUB_API_URL

#583

Author: epompeii

services/cli/src/bencher/sub/project/run/ci/github_actions.rs

@@ -11,6 +11,7 @@ const GITHUB_ACTIONS: &str = "GITHUB_ACTIONS";
 const GITHUB_EVENT_PATH: &str = "GITHUB_EVENT_PATH";
 const GITHUB_EVENT_NAME: &str = "GITHUB_EVENT_NAME";
 const GITHUB_SHA: &str = "GITHUB_SHA";
+const GITHUB_API_URL: &str = "GITHUB_API_URL";
 const GITHUB_STEP_SUMMARY: &str = "GITHUB_STEP_SUMMARY";
 
 const PULL_REQUEST: &str = "pull_request";
@@ -74,6 +75,8 @@ pub enum GitHubError {
     BadFullName(String),
     #[error("GitHub Action event repository full name is not of the form `owner/repo`: ({0})")]
     InvalidFullName(String),
+    #[error("Failed to parse GitHub API URL: {0}")]
+    BaseUri(octocrab::Error),
     #[error("Failed to authenticate as GitHub Action: {0}")]
     Auth(octocrab::Error),
     #[error("Failed to list GitHub PR comments: {0}")]
@@ -203,7 +206,7 @@ impl GitHubActions {
                         docker_env(GITHUB_EVENT_NAME)
                     );
             return self
-                .create_github_check(report_comment, &event_str, &event)
+                .create_github_check(report_comment, log, &event_str, &event)
                 .await;
         };
 
@@ -227,6 +230,7 @@ impl GitHubActions {
     async fn create_github_check(
         &self,
         report_comment: &ReportComment,
+        log: bool,
         event_str: &str,
         event: &serde_json::Value,
     ) -> Result<(), GitHubError> {
@@ -247,8 +251,12 @@ impl GitHubActions {
             annotations: Vec::new(),
             images: Vec::new(),
         };
-        let check = Octocrab::builder()
-            .user_access_token(self.token.clone())
+
+        let mut builder = Octocrab::builder().user_access_token(self.token.clone());
+        if let Some(url) = github_api_url(log) {
+            builder = builder.base_uri(url).map_err(GitHubError::BaseUri)?;
+        }
+        let check = builder
             .build()
             .map_err(GitHubError::Auth)?
             .checks(owner, repo)
@@ -286,10 +294,11 @@ impl GitHubActions {
         let full_name = repository_full_name(event_str, event)?;
         let (owner, repo) = split_full_name(full_name)?;
 
-        let github_client = Octocrab::builder()
-            .user_access_token(self.token.clone())
-            .build()
-            .map_err(GitHubError::Auth)?;
+        let mut builder = Octocrab::builder().user_access_token(self.token.clone());
+        if let Some(url) = github_api_url(log) {
+            builder = builder.base_uri(url).map_err(GitHubError::BaseUri)?;
+        }
+        let github_client = builder.build().map_err(GitHubError::Auth)?;
 
         // Get the comment ID if it exists
         let comment_id = get_comment(
@@ -419,3 +428,16 @@ fn is_permissions_error(err: &octocrab::Error) -> bool {
     err.to_string()
         .contains("Resource not accessible by integration")
 }
+
+fn github_api_url(log: bool) -> Option<String> {
+    if let Ok(url) = std::env::var(GITHUB_API_URL) {
+        Some(url)
+    } else {
+        cli_eprintln_quietable!(
+            log,
+            "Failed to get GitHub API URL, defaulting to `https://api.github.com`\n{}",
+            docker_env(GITHUB_API_URL)
+        );
+        None
+    }
+}

services/console/src/chunks/docs-explanation/bencher-run/de/github-actions.mdx

@@ -18,4 +18,5 @@ In jedem Fall werden die Ergebnisse auch zur Zusammenfassung des Jobs hinzugefü
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server nur)

services/console/src/chunks/docs-explanation/bencher-run/en/github-actions.mdx

@@ -18,4 +18,5 @@ In either case, the results will also be added to the job summary.
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server only)

services/console/src/chunks/docs-explanation/bencher-run/es/github-actions.mdx

@@ -18,4 +18,5 @@ En cualquier caso, los resultados también se agregarán al resumen del trabajo.
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server solamente)

services/console/src/chunks/docs-explanation/bencher-run/fr/github-actions.mdx

@@ -18,4 +18,5 @@ Dans les deux cas, les résultats seront également ajoutés au résumé du trav
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server uniquement)

services/console/src/chunks/docs-explanation/bencher-run/ja/github-actions.mdx

@@ -17,4 +17,5 @@
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server のみ)

services/console/src/chunks/docs-explanation/bencher-run/ko/github-actions.mdx

@@ -18,4 +18,5 @@
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server 전용)

services/console/src/chunks/docs-explanation/bencher-run/pt/github-actions.mdx

@@ -18,4 +18,5 @@ Em ambos os casos, os resultados também serão adicionados ao resumo do trabalh
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server apenas)

services/console/src/chunks/docs-explanation/bencher-run/ru/github-actions.mdx

@@ -11,4 +11,5 @@
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server только)

services/console/src/chunks/docs-explanation/bencher-run/zh/github-actions.mdx

@@ -11,4 +11,5 @@
 > - `GITHUB_ACTIONS`
 > - `GITHUB_EVENT_NAME`
 > - `GITHUB_EVENT_PATH`
-> - `GITHUB_SHA`
+> - `GITHUB_SHA`
+> - `GITHUB_API_URL` (GitHub Enterprise Server 专用)