Update Readme links and add env example (#20)

* Update Readme links and add env example Signed-off-by: Peter Zhu <[email protected]> * ignore env example Signed-off-by: Peter Zhu <[email protected]> * Update workflow naming Signed-off-by: Peter Zhu <[email protected]> * update link Signed-off-by: Peter Zhu <[email protected]> --------- Signed-off-by: Peter Zhu <[email protected]>
opensearch-project · Oct 3, 2024 · 8b9662b · 8b9662b
1 parent 3213986
commit 8b9662b
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 8 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,5 @@
+WEBHOOK_PROXY_URL=
+APP_ID=
+PRIVATE_KEY=
+WEBHOOK_SECRET=
+INSTALLATION_ID=
diff --git a/.github/workflows/check-version-bump.yml b/.github/workflows/check-version-bump.yml
@@ -1,5 +1,5 @@
 ---
-name: Check Version Bump
+name: check-version-bump
 
 on:
   pull_request:

diff --git a/.github/workflows/license-header-checker.yml b/.github/workflows/license-header-checker.yml
@@ -1,5 +1,5 @@
 ---
-name: License Header Checker
+name: license-header-checker
 
 on: [push, pull_request]
 

diff --git a/.gitignore b/.gitignore
@@ -3,7 +3,7 @@ npm-debug.log
 *.pem
 *.swp*
 !mock-cert.pem
-.env*
+.env
 coverage
 junit.xml
 bin

diff --git a/.licenserc.json b/.licenserc.json
@@ -28,6 +28,7 @@
     ".gz",
     ".toml",
     ".ini",
-    "gradle/wrapper"
+    "gradle/wrapper",
+    ".env.example"
   ]
 }
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ This repository hosts the source code of an automation app to handle the daily a
 
 ## Project Resources
 
-The automation app utilizes the [Probot](https://probot.github.io/) framework and [Octokit](https://docs.github.com/en/rest/using-the-rest-api/libraries-for-the-rest-api?apiVersion=2022-11-28) library to perform user-defined operations on top of the resources within GitHub. See [configs](configs/operations/hello-world.yml) yaml for more information.
+The automation app utilizes the [Probot](https://probot.github.io/) framework and [Octokit](https://docs.github.com/en/rest/using-the-rest-api/libraries-for-the-rest-api?apiVersion=2022-11-28) library to perform user-defined operations on top of the resources within GitHub. See [configs](configs) yaml for more information.
 
 ## Usages
 
@@ -33,8 +33,8 @@ A `Service` is an instance of the app that manages and manipulates specific `Res
 
 To create a service, you need two configuration files:
 
-- **Resource configuration file**: Defines the resources that the service will manage or modify (`configs/resources/sample-resource.yml`).
-- **Operation configuration file**: Defines the operations (tasks) that the service will execute with the resources (`configs/resources/sample-operation.yml`).
+- **Resource configuration file**: Defines the resources that the service will manage or modify. [Sample Resource Config](configs/resources/sample-resource.yml).
+- **Operation configuration file**: Defines the operations (tasks) that the service will execute with the resources. [Sample Operation Config](configs/operations/sample-operation.yml).
 
 ### Start the Service
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "opensearch-automation-app",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "An Automation App that handles all your GitHub Repository Activities",
   "author": "Peter Zhu",
   "homepage": "https://github.com/opensearch-project/automation-app",
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ npm-debug.log @@
     *.pem
     *.swp*
     !mock-cert.pem
-    .env*
+    .env
     coverage
     junit.xml
     bin
@@ Expand Down @@