From b6c0abb6faf3dea2fe3be300af224c9f2e01f019 Mon Sep 17 00:00:00 2001 From: Peter Zhu Date: Thu, 26 Sep 2024 12:36:05 -0400 Subject: [PATCH] Improve wording and add license-hearder-checker Signed-off-by: Peter Zhu --- .github/workflows/build.yml | 2 +- .github/workflows/license-header-checker.yml | 12 +++++++ .licenserc.json | 35 ++++++++++++++++++++ MAINTAINERS.md | 2 +- README.md | 2 +- jest.config.js | 4 +-- 6 files changed, 52 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/license-header-checker.yml create mode 100644 .licenserc.json diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b7f27c2..c2f4647 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,5 +1,5 @@ --- -name: build app +name: build-test on: [push, pull_request] diff --git a/.github/workflows/license-header-checker.yml b/.github/workflows/license-header-checker.yml new file mode 100644 index 0000000..d026f0b --- /dev/null +++ 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 new file mode 100644 index 0000000..a29865e --- /dev/null +++ b/.licenserc.json @@ -0,0 +1,35 @@ +{ + "**/*.*": [ + " Copyright OpenSearch Contributors", + " SPDX-License-Identifier: Apache-2.0" + ], + "ignore": [ + ".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 index 0fa6ff0..2274fe4 100644 --- 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 index bdc11fe..2e33f55 100644 --- 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 index 6d8f326..44ead85 100644 --- a/jest.config.js +++ b/jest.config.js @@ -1,7 +1,7 @@ module.exports = { testEnvironment: 'node', - roots: ['/test'], // Points to 'test' directory where your test files live - testMatch: ['**/*.test.ts'], // Match test files ending with `.test.ts` + roots: ['/test'], + testMatch: ['**/*.test.ts'], transform: { '^.+\\.tsx?$': 'ts-jest', },