Skip to content

Commit

Permalink
Improve wording and add license-hearder-checker
Browse files Browse the repository at this point in the history
Signed-off-by: Peter Zhu <[email protected]>
  • Loading branch information
peterzhuamazon authored and prudhvigodithi committed Sep 26, 2024
1 parent b7d4959 commit b6c0abb
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: build app
name: build-test

on: [push, pull_request]

Expand Down
12 changes: 12 additions & 0 deletions .github/workflows/license-header-checker.yml
Original file line number Diff line number Diff line change
@@ -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
35 changes: 35 additions & 0 deletions .licenserc.json
Original file line number Diff line number Diff line change
@@ -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"
]
}
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -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',
},
Expand Down

0 comments on commit b6c0abb

Please sign in to comment.