Github Workflow Monitoring

Signed-off-by: Prudhvi Godithi <pgodithi@amazon.com>
opensearch-project · Oct 4, 2024 · 9e5a53f · 9e5a53f
1 parent 1e4060f
commit 9e5a53f
Show file tree

Hide file tree

Showing 9 changed files with 836 additions and 191 deletions.
diff --git a/.github/workflows/check-version-bump.yml b/.github/workflows/check-version-bump.yml
@@ -14,11 +14,11 @@ jobs:
         uses: EndBug/version-check@v2
         with:
           diff-search: true
-      
+
       - name: Log when changed
         if: steps.check.outputs.changed == 'true'
         run: 'echo "Version change found in commit ${{ steps.check.outputs.commit }}! New version: ${{ steps.check.outputs.version }} (${{ steps.check.outputs.type }})"'
-      
+
       - name: Log when unchanged
         if: steps.check.outputs.changed == 'false'
         run: 'echo "No version change! Please bump the version in package.json!" && exit 1'
diff --git a/README.md b/README.md
@@ -64,13 +64,14 @@ When you run the above command, the following takes place:
 1. Registers and listens for events, executes the `Tasks` defined in the operation config. These tasks will be executed sequentially when the corresponding events occur.
 
 #### List of Environment Variables (You can use them directly in the startup command, export them, or add them to the `.env` file):
+
 | Name                        | Type    | Default   | Description                                                                                                                                                        | Example                                   |
-|-----------------------------|---------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------|
+| --------------------------- | ------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | --- |
 | RESOURCE_CONFIG             | String  | ''        | Path to resource config yaml file.                                                                                                                                 | 'configs/resources/sample-resource.yml'   |
 | OPERATION_CONFIG            | String  | ''        | Path to operation config yaml file.                                                                                                                                | 'configs/operations/sample-operation.yml' |
 | INSTALLATION_ID             | String  | ''        | Installation Id of your GitHub App, must install the App to repositories before retrieving the id.                                                                 | '1234567890'                              |
 | ADDITIONAL_RESOURCE_CONTEXT | Boolean | false     | Setting true will let each resource defined in RESOURCE_CONFIG to call GitHub Rest API and GraphQL for more detailed context (ex: node_id). Increase startup time. | true / false                              |
-| SERVICE_NAME                | String  | 'default' | Set Service Name                                                                                                                                                   | 'My Service'                              |'
+| SERVICE_NAME                | String  | 'default' | Set Service Name                                                                                                                                                   | 'My Service'                              | '   |
 
 #### Start the Service with Docker
 

diff --git a/configs/operations/github-workflow-runs-monitor.yml b/configs/operations/github-workflow-runs-monitor.yml
@@ -8,6 +8,10 @@ tasks:
   - name: Workflow Runs Monitor Operation
     call: github-workflow-runs-monitor@default
     args:
+      workflows:
+        - 'Publish snapshots to Apache Maven repositories'
+        - 'Publish snapshots to maven'
+        - 'Run performance benchmark on pull request'
       # https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows
       events:
         - 'pull_request'

diff --git a/docker/README.md b/docker/README.md
@@ -31,12 +31,10 @@ The `docker-compose.yml` is configured to use a Node.js image and to run the app
 
 The [Dockerfile](Dockerfile) is used to create a Docker image for the app.
 
-
 ### Docker Compose File
 
 The [compose.yml](compose.yaml) file sets up a service (automation-app) to run the app:
 
-
 ### Run multiple Services
 
 This allows to run multiple instances of the service with different configurations and ports.