Improve wording and add license-hearder-checker

Signed-off-by: Peter Zhu <[email protected]>
opensearch-project · Sep 26, 2024 · 13a8700 · 13a8700
1 parent b7d4959
commit 13a8700
Show file tree

Hide file tree

Showing 33 changed files with 328 additions and 120 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,3 +1,12 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
 module.exports = {
   env: {
     browser: false,

diff --git a/.github/workflows/build.yml → .github/workflows/build-test.yml b/.github/workflows/build.yml → .github/workflows/build-test.yml
@@ -1,5 +1,5 @@
 ---
-name: build app
+name: build-test
 
 on: [push, pull_request]
 
@@ -27,3 +27,5 @@ jobs:
         run: echo "Please run 'npm run format' before commiting the code!"
       - name: Run build
         run: npm run build
+      - name: Run Test
+        run: npm test
diff --git a/.github/workflows/license-header-checker.yml b/.github/workflows/license-header-checker.yml
@@ -0,0 +1,12 @@
+---
+name: License Header Checker
+
+on: [push, pull_request]
+
+jobs:
+  license-header-checker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Add License Header
+        run: npx @kt3k/license-checker
diff --git a/.licenserc.json b/.licenserc.json
@@ -0,0 +1,33 @@
+{
+  "**/*.*": [" Copyright OpenSearch Contributors", " SPDX-License-Identifier: Apache-2.0"],
+  "ignore": [
+    ".prettierrc",
+    ".md",
+    ".flake8",
+    ".yml",
+    ".yaml",
+    ".bat",
+    ".json",
+    ".txt",
+    ".config",
+    ".swp",
+    "tests/tests_test_workflow/test_integ_workflow/integ_test/data/artifacts/",
+    "tests/tests_sign_workflow/data/signature/",
+    "tests/tests_assemble_workflow/data/artifacts/",
+    ".png",
+    "settings.gradle",
+    ".git",
+    ".lychee.excludes",
+    ".whitesource",
+    ".shellcheckrc",
+    ".lock",
+    ".gradle",
+    ".cert",
+    ".key",
+    ".jar",
+    ".gz",
+    ".toml",
+    ".ini",
+    "gradle/wrapper"
+  ]
+}
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -10,7 +10,7 @@ This document contains a list of maintainers in this repo. See [opensearch-proje
 
 | Maintainer      | GitHub ID                                           | Affiliation |
 | --------------- | --------------------------------------------------- | ----------- |
-| Saurabh Sing    | [getsaurabh02](https://github.com/getsaurabh02)     | Amazon      |
+| Saurabh Singh   | [getsaurabh02](https://github.com/getsaurabh02)     | Amazon      |
 | Peter Zhu       | [peterzhuamazon](https://github.com/peterzhuamazon) | Amazon      |
 | Prudhvi Godithi | [prudhvigodithi](https://github.com/prudhvigodithi) | Amazon      |
 | Sayali Gaikawad | [gaiksaya](https://github.com/gaiksaya)             | Amazon      |

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ The automation app utilizes the [Probot](https://probot.github.io/) framework an
 
 ### Service
 
-A **Service** is an instance of the app that manages and manipulates specific `Resource` while performing defined `Operation`.
+A `Service` is an instance of the app that manages and manipulates specific `Resource` while performing defined `Operation`.
 
 - **Resource**: Objects or entities the service will manage or modify, such as GitHub organizations, project, repositories, issues, etc.
 - **Operation**: A list of `Tasks` triggered by events with the resources.

diff --git a/jest.config.js b/jest.config.js
@@ -1,7 +1,7 @@
 module.exports = {
   testEnvironment: 'node',
-  roots: ['<rootDir>/test'], // Points to 'test' directory where your test files live
-  testMatch: ['**/*.test.ts'], // Match test files ending with `.test.ts`
+  roots: ['<rootDir>/test'],
+  testMatch: ['**/*.test.ts'],
   transform: {
     '^.+\\.tsx?$': 'ts-jest',
   },

diff --git a/src/app.ts b/src/app.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/call/create-issue-comment.ts b/src/call/create-issue-comment.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/call/github-merged-pulls-monitor.ts b/src/call/github-merged-pulls-monitor.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to
@@ -10,7 +11,7 @@
 // Description  : Monitors the CI workflows of merged pull requests, providing metrics that give an overview of whether pull requests were merged without passing CI checks.
 
 import { Probot } from 'probot';
-import { OpensearchClient } from '../utility/opensearchclient';
+import { OpensearchClient } from '../utility/opensearch/opensearch-client';
 
 export default async function githubMergedPullsMonitor(app: Probot, context: any): Promise<void> {
   const pr = context.payload.pull_request;

diff --git a/src/call/github-workflow-runs-monitor.ts b/src/call/github-workflow-runs-monitor.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to
@@ -9,16 +10,16 @@
 // Name         : githubWorkflowRunsMonitor
 // Description  : prints the githubWorkflowRunsMonitor output and indexes logData to OpenSearch
 // Arguments    :
-//   - events     : The list of events to monitor and index, from https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows.
+//  - events     : The list of events to monitor and index, from https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows.
 
 import { Probot } from 'probot';
-import { OpensearchClient } from '../utility/opensearchclient';
+import { OpensearchClient } from '../utility/opensearch/opensearch-client';
 
-interface WorkflowRunEvents {
+interface WorkflowRunMonitorArgs {
   events: string[];
 }
 
-export default async function githubWorkflowRunsMonitor(app: Probot, context: any, { events }: WorkflowRunEvents): Promise<void> {
+export default async function githubWorkflowRunsMonitor(app: Probot, context: any, { events }: WorkflowRunMonitorArgs): Promise<void> {
   const job = context.payload.workflow_run;
 
   if (!events.includes(job?.event)) {

diff --git a/src/call/print-to-console.ts b/src/call/print-to-console.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/config/config.ts b/src/config/config.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/config/operation-config.ts b/src/config/operation-config.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/config/resource-config.ts b/src/config/resource-config.ts
@@ -1,3 +1,12 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ * The OpenSearch Contributors require contributions made to
+ * this file be licensed under the Apache-2.0 license or a
+ * compatible open source license.
+ */
+
 import { ProbotOctokit } from 'probot';
 import { ResourceData, OrganizationData } from './types';
 import { Resource } from '../service/resource/resource';

diff --git a/src/config/types.ts b/src/config/types.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to
@@ -44,5 +45,5 @@ export interface TaskData {
 }
 
 export interface TaskArgData {
-  [key: string]: string;
+  [key: string]: string | string[];
 }
diff --git a/src/service/operation/operation.ts b/src/service/operation/operation.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/operation/task.ts b/src/service/operation/task.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/resource/entity.ts b/src/service/resource/entity.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/resource/issue.ts b/src/service/resource/issue.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/resource/organization.ts b/src/service/resource/organization.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/resource/project-field.ts b/src/service/resource/project-field.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/resource/project.ts b/src/service/resource/project.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/resource/repository.ts b/src/service/resource/repository.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/resource/resource.ts b/src/service/resource/resource.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/service/service.ts b/src/service/service.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to
@@ -14,7 +15,7 @@ import { Operation } from './operation/operation';
 import { Task } from './operation/task';
 import { ResourceConfig } from '../config/resource-config';
 import { OperationConfig } from '../config/operation-config';
-import { octokitAuth } from '../utility/octokit';
+import { octokitAuth } from '../utility/probot/octokit';
 
 export class Service {
   private name: string;

diff --git a/src/utility/opensearchclient.ts → src/utility/opensearch/opensearch-client.ts b/src/utility/opensearchclient.ts → src/utility/opensearch/opensearch-client.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to

diff --git a/src/utility/octokit.ts → src/utility/probot/octokit.ts b/src/utility/octokit.ts → src/utility/probot/octokit.ts
@@ -1,4 +1,5 @@
-/**
+/*
+ * Copyright OpenSearch Contributors
  * SPDX-License-Identifier: Apache-2.0
  *
  * The OpenSearch Contributors require contributions made to