Merge pull request #2913 from markuscodes1/feature/github-scaffolder-baseurl

Scaffolder backend- provide base url for creating apps in Enterprise GitHub

.changeset/selfish-bats-perform.md

@@ -0,0 +1,6 @@
+---
+'@backstage/plugin-scaffolder': patch
+'@backstage/plugin-scaffolder-backend': patch
+---
+
+The new `scaffolder.github.baseUrl` config property allows to specify a custom base url for GitHub enterprise instances

app-config.yaml

@@ -148,6 +148,7 @@ catalog:
 
 scaffolder:
   github:
+    host: https://github.com
     token:
       $env: GITHUB_TOKEN
     visibility: public # or 'internal' or 'private'

packages/backend/src/plugins/scaffolder.ts

@@ -68,7 +68,12 @@ export default async function createPlugin({
       ) as RepoVisibilityOptions;
 
       const githubToken = githubConfig.getString('token');
-      const githubClient = new Octokit({ auth: githubToken });
+      const githubHost =
+        githubConfig.getOptionalString('host') ?? 'https://github.com';
+      const githubClient = new Octokit({
+        auth: githubToken,
+        baseUrl: githubHost,
+      });
       const githubPublisher = new GithubPublisher({
         client: githubClient,
         token: githubToken,

packages/create-app/templates/default-app/packages/backend/src/plugins/scaffolder.ts

@@ -48,7 +48,8 @@ export default async function createPlugin({
       ) as RepoVisibilityOptions;
 
       const githubToken = githubConfig.getString('token');
-      const githubClient = new Octokit({ auth: githubToken });
+      const githubHost = githubConfig.getOptionalString('host');
+      const githubClient = new Octokit({ auth: githubToken, baseUrl: githubHost });
       const githubPublisher = new GithubPublisher({
         client: githubClient,
         token: githubToken,