From a239a4a5e554d50bbf74a5e67e9e05aa0b441cfa Mon Sep 17 00:00:00 2001
From: "@pawelmitka" <pawel.mitka@brainly.com>
Date: Wed, 1 Sep 2021 09:30:50 +0200
Subject: [PATCH] refactor: rename helpers.ts to OctokitProvider.ts and add
 docstrings

Signed-off-by: @pawelmitka <pawel.mitka@brainly.com>
---
 .../{helpers.test.ts => OctokitProvider.test.ts}       |  2 +-
 .../builtin/github/{helpers.ts => OctokitProvider.ts}  | 10 +++++++++-
 .../actions/builtin/github/githubActionsDispatch.ts    |  2 +-
 .../scaffolder/actions/builtin/github/githubWebhook.ts |  2 +-
 .../src/scaffolder/actions/builtin/publish/github.ts   |  2 +-
 5 files changed, 13 insertions(+), 5 deletions(-)
 rename plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/{helpers.test.ts => OctokitProvider.test.ts} (97%)
 rename plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/{helpers.ts => OctokitProvider.ts} (90%)

diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.test.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/OctokitProvider.test.ts
similarity index 97%
rename from plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.test.ts
rename to plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/OctokitProvider.test.ts
index a72a775701..91b23f40dd 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.test.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/OctokitProvider.test.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { OctokitProvider } from './helpers';
+import { OctokitProvider } from './OctokitProvider';
 import { ScmIntegrations } from '@backstage/integration';
 import { ConfigReader } from '@backstage/config';
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/OctokitProvider.ts
similarity index 90%
rename from plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.ts
rename to plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/OctokitProvider.ts
index 4ed10b9d64..bea027a91b 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/helpers.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/OctokitProvider.ts
@@ -28,7 +28,10 @@ export type OctokitIntegration = {
   owner: string;
   repo: string;
 };
-
+/**
+ * OctokitProvider provides Octokit client based on ScmIntegrationsRegistry configuration.
+ * OctokitProvider supports GitHub credentials caching out of the box.
+ */
 export class OctokitProvider {
   private readonly integrations: ScmIntegrationRegistry;
   private readonly credentialsProviders: Map<string, GithubCredentialsProvider>;
@@ -43,6 +46,11 @@ export class OctokitProvider {
     );
   }
 
+  /**
+   * gets standard Octokit client based on repository URL.
+   *
+   * @param repoUrl Repository URL
+   */
   async getOctokit(repoUrl: string): Promise<OctokitIntegration> {
     const { owner, repo, host } = parseRepoUrl(repoUrl, this.integrations);
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubActionsDispatch.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubActionsDispatch.ts
index c7d2919efb..661101d184 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubActionsDispatch.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubActionsDispatch.ts
@@ -15,7 +15,7 @@
  */
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { createTemplateAction } from '../../createTemplateAction';
-import { OctokitProvider } from './helpers';
+import { OctokitProvider } from './OctokitProvider';
 
 export function createGithubActionsDispatchAction(options: {
   integrations: ScmIntegrationRegistry;
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubWebhook.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubWebhook.ts
index eabfebeb28..33ed415062 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubWebhook.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/github/githubWebhook.ts
@@ -15,7 +15,7 @@
  */
 import { ScmIntegrationRegistry } from '@backstage/integration';
 import { createTemplateAction } from '../../createTemplateAction';
-import { OctokitProvider } from './helpers';
+import { OctokitProvider } from './OctokitProvider';
 
 type ContentType = 'form' | 'json';
 
diff --git a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts
index eaedbf275f..b32f9b5b3f 100644
--- a/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts
+++ b/plugins/scaffolder-backend/src/scaffolder/actions/builtin/publish/github.ts
@@ -21,7 +21,7 @@ import {
 import { getRepoSourceDirectory } from './util';
 import { createTemplateAction } from '../../createTemplateAction';
 import { Config } from '@backstage/config';
-import { OctokitProvider } from '../github/helpers';
+import { OctokitProvider } from '../github/OctokitProvider';
 
 type Permission = 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
 type Collaborator = { access: Permission; username: string };