Comment possibly-confusing logic

freckle · Sep 26, 2024 · d0acc7e · d0acc7e
1 parent 612f5df
commit d0acc7e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/GitHub/App/Token/Generate.hs b/src/GitHub/App/Token/Generate.hs
@@ -129,6 +129,12 @@ generateOwnerTokenScoped
   -> Owner
   -> m AccessToken
 generateOwnerTokenScoped create creds owner = do
+  -- If a repositories scope is given, use the first one (along with owner) to
+  -- get the installation. Otherwise use the org or user endpoint. This matches
+  -- how actions/create-github-app-token works:
+  --
+  -- https://github.com/actions/create-github-app-token/blob/5d869da34e18e7287c1daad50e0b8ea0f506ce69/lib/main.js#L113-L166
+  --
   installation <- getInstallation creds $ case (create.repositories, owner) of
     (repo : _, Org org) -> "/repos/" <> org <> "/" <> repo
     (repo : _, User username) -> "/repos/" <> username <> "/" <> repo