Merge branch 'main' of https://github.com/newmansc2/openEBL-2024-07-S…

…i-Heaters into pr/44

.github/workflows/AutomaticApprove.yml

@@ -0,0 +1,18 @@
+name: Automatic Approve
+on:
+  schedule:
+    - cron: "*/5 * * * *"
+
+jobs:
+  automatic-approve:
+    name: Automatic Approve
+    if: github.repository_owner == 'SiEPIC'
+       #if: >-
+       #github.event.pull_request.user.login != 'SiEPIC' && repository_dispatch.organization
+    runs-on: ubuntu-latest
+    steps:
+      - name: Automatic Approve
+        uses: mheap/automatic-approve-action@v1
+        with:
+          token: ${{ secrets.PAT }}
+          workflows: "run-verification.yml,run-drc.yml,run-yaml-verification.yml,yaml_file.yml"

.github/workflows/merge_complete.yml

@@ -3,11 +3,10 @@ name: Merge complete
 on:
   pull_request_review:
   # merge the layout after the pull request is approved
-    types: 
-      - submitted
+    types: [submitted]
 
 jobs:
-  merge:
+  approved:
     if: github.event.review.state == 'APPROVED'
     runs-on: ubuntu-latest
 

.github/workflows/run-drc.yml

@@ -0,0 +1,109 @@
+name: Run DRC Verification
+
+on:
+  workflow_dispatch:
+  workflow_run:
+    workflows: ["Run Python Files"]
+    types:
+      - completed
+  push:
+    paths:
+      - 'submissions/**.gds'
+      - 'submissions/**.oas'
+    branches:
+      - '**'
+  pull_request:
+    paths:
+      - 'submissions/**.gds'
+      - 'submissions/**.oas'
+    branches:
+      - '**'
+
+
+jobs:
+  verification:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout repo content
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+        # can also specify python version if needed
+      - name: setup python
+        uses: actions/setup-python@v4
+
+      - name: install python packages
+        run: |
+          pip install klayout
+          
+      - name: get .gds and .oas files, run example layout verification
+        id: run-script
+        run: |
+        
+          # if the action is being triggered after running python files, get resulting oas files from txt file
+          # github actions is not configured to detect files pushed from another action, thus we cannot use the method below
+          if [ -s "python-to-gds_oas.txt" ] && [ -n "$(cat python-to-gds_oas.txt)" ]; then
+            export FILES=$(cat python-to-gds_oas.txt)
+            IFS=' '
+            echo "" > python-to-gds_oas.txt
+             
+            # push empty text file to repo
+            git config --local user.email "${{ github.actor }}@users.noreply.github.com"
+            git config --local user.name "${{ github.actor }}"
+            git add python-to-gds_oas.txt
+            git commit -m "Emptying text file" 
+            git push
+
+          else
+            if [ "${{ github.event_name }}" = "pull_request" ]; then
+              # triggered on pull request, get all changed / added files from forked repo
+              export FILES=$(git diff --name-only --diff-filter=ACM origin/main...HEAD | grep -E '\.(gds|oas)$' | sed 's|^submissions/||')
+            else
+              # triggered push, locate the changed / added .gds and .oas files in the submission folder
+              export FILES=$(git diff --name-status --diff-filter=ACM --relative=submissions ${{ github.event.before }} ${{ github.sha }} submissions | grep -E '\.(gds|oas)$' | awk '{print $2}')
+            fi
+            IFS=$'\n'
+          fi
+
+          # print the names of the files
+          echo "Files for verification; $FILES"
+
+          files_with_errors=""
+        
+          # run verification on all files
+          for file in $FILES; do
+
+            echo "Running verification on $file"
+
+            output=$(python run_DRC.py "submissions/$file")
+
+            # get number of errors
+            errors_from_output=$(echo "$output" | tail -n 1)
+
+            echo "$errors_from_output errors detected for $file"
+
+            # if file results in verification errors add to string files_with_errors
+            if [[ "$errors_from_output" -ge 1 ]]; then
+              files_with_errors+="$file, $errors_from_output errors. "
+              echo $files_with_errors >> $GITHUB_STEP_SUMMARY
+              echo $output >> $GITHUB_STEP_SUMMARY
+            fi
+
+            echo "Done verification on $file"
+          done
+
+          echo "files_with_errors=$files_with_errors" >> $GITHUB_ENV
+
+      - name: fail if there are errors from layout verification
+        run: |
+          if [ -z "$files_with_errors" ]; then
+            echo "No errors detected."
+            echo "No errors detected." >> $GITHUB_STEP_SUMMARY
+          else
+            echo "Errors detected: $files_with_errors"
+            echo "Errors detected: $files_with_errors" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+

.github/workflows/run-verification.yml

@@ -9,7 +9,9 @@ on:
   push:
     paths:
       - 'submissions/**.gds'
+      - 'submissions/**.GDS'
       - 'submissions/**.oas'
+      - 'submissions/**.OAS'
     branches:
       - '**'
   pull_request:
@@ -27,6 +29,28 @@ jobs:
         with:
           fetch-depth: 0
 
+
+      #- name: get changed files
+      #  uses: jitterbit/get-changed-files@v1
+
+      #- name: get changed files, list
+      #  run: |
+      #    for changed_file in ${{ steps.files.outputs.all }}; do
+      #      echo "Do something with this ${changed_file}."
+      #    done
+
+
+      - name: write what triggered this workflow to a txt file
+        run: |
+          echo "${{ github.event_name }}" > trigger_info.txt
+          cat trigger_info.txt
+          
+      - name: upload trigger txt file as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: verification-trigger
+          path: trigger_info.txt
+
         # can also specify python version if needed
       - name: setup python
         uses: actions/setup-python@v4
@@ -35,41 +59,64 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install klayout SiEPIC siepic_ebeam_pdk
-          python -m pip install --upgrade SiEPIC
-          
-      - name: get .gds and .oas files, run example layout verification
-        id: run-script
+
+      - name: download latest python-to-oas-gds artifact from triggering workflow 
+        uses: dawidd6/action-download-artifact@v2
+        with:
+          run_id: ${{ github.event.workflow_run.id }}
+          name: python-to-oas-gds
+          path: ./binary_files
+          search_artifacts: true
+        if: ${{ github.event_name == 'workflow_run' }}
+
+      - name: get .gds and .oas files
         run: |
-        
-          # if the action is being triggered after running python files, get resulting oas files from txt file
-          # github actions is not configured to detect files pushed from another action, thus we cannot use the method below
-          if [ -s "python-to-gds_oas.txt" ] && [ -n "$(cat python-to-gds_oas.txt)" ]; then
-            export FILES=$(cat python-to-gds_oas.txt)
-            IFS=' '
-            echo "" > python-to-gds_oas.txt
-             
-            # push empty text file to repo
-            git config --local user.email "${{ github.actor }}@users.noreply.github.com"
-            git config --local user.name "${{ github.actor }}"
-            git add python-to-gds_oas.txt
-            git commit -m "Emptying text file" 
-            git push
 
+          # if the action is being triggered after running python files, get resulting oas/gds files from artifact
+          # github actions is not configured to detect files pushed from another action, thus we cannot use the 'else' method below
+          if [ "${{ github.event_name }}" == "workflow_run" ]; then
+            FILES=$(ls ./binary_files)
           else
-            if [ "${{ github.event_name }}" = "pull_request" ]; then
+            if [[ "${{ github.event_name }}" == "pull_request" || "${{ github.event_name }}" == "pull_request_target" ]]; then
               # triggered on pull request, get all changed / added files from forked repo
-              export FILES=$(git diff --name-only --diff-filter=ACM FETCH_HEAD | grep -E '\.(gds|oas)$' | sed 's|^submissions/||')
+              FILES=$(git diff --name-only --diff-filter=ACM origin/main...HEAD  | grep -i -E '\.(gds|oas)$' | sed 's|^submissions/||')
+              #FILES=$(git diff --name-only --diff-filter=ACM FETCH_HEAD | grep -i -E '\.(gds|oas)$' | sed 's|^submissions/||')
             else
               # triggered push, locate the changed / added .gds and .oas files in the submission folder
-              export FILES=$(git diff --name-status --diff-filter=ACM --relative=submissions ${{ github.event.before }} ${{ github.sha }} submissions | grep -E '\.(gds|oas)$' | awk '{print $2}')
+              FILES=$(git diff --name-status --diff-filter=ACM --relative=submissions ${{ github.event.before }} ${{ github.sha }} submissions | grep -i -E '\.(gds|oas)$' | awk '{print $2}')
             fi
-            IFS=$'\n'
           fi
+                 
+          # we cannot set a multiline env vars so we must change it to single line (seperated by commas) if we have more than one file
+          if [ $(echo "$FILES" | wc -l) -gt 1 ]; then
+            # Replace newlines with a delimiter (e.g., comma)
+            FILES_SINGLE_LINE=$(echo "$FILES" | tr '\n' ',')
+          else
+            # Keep the original content without modification
+            FILES_SINGLE_LINE="$FILES"
+          fi
+
+          echo "$FILES_SINGLE_LINE"
+          echo "FILES_SINGLE_LINE=$FILES_SINGLE_LINE" >> $GITHUB_ENV
 
+      - name: run layout verification
+        run: |
+
+          # Check if there is a comma in the variable and revert it back to a multiline var
+          if [[ "$FILES_SINGLE_LINE" == *","* ]]; then
+            # Replace the delimiter with newlines
+            FILES=$(echo "$FILES_SINGLE_LINE" | tr ',' '\n')
+          else
+            # No comma found, keep the original content without modification
+            FILES="$FILES_SINGLE_LINE"
+          fi
+        
           # print the names of the files
           echo "Files for verification; $FILES"
 
           files_with_errors=""
+
+          IFS=$'\n'
         
           # run verification on all files
           for file in $FILES; do
@@ -85,6 +132,7 @@ jobs:
 
             # if file results in verification errors add to string files_with_errors
             if [[ "$errors_from_output" -ge 1 ]]; then
+              echo "$output"
               files_with_errors+="$file, $errors_from_output errors. "
               echo $files_with_errors >> $GITHUB_STEP_SUMMARY
               echo $output >> $GITHUB_STEP_SUMMARY
@@ -93,11 +141,14 @@ jobs:
             echo "Done verification on $file"
           done
 
+          echo "$output" > verification_output.txt
           echo "files_with_errors=$files_with_errors" >> $GITHUB_ENV
 
+                    
+
       - name: move output files to new folder
         run: |
-          export OUTPUT_FILES=$(find /home/runner/work/openEBL-2024-02/openEBL-2024-02/submissions -name "*.lyrdb")
+          export OUTPUT_FILES=$(find /home/runner/work/openEBL-2024-07-Si-Heaters/openEBL-2024-07-Si-Heaters/submissions -name "*.lyrdb")
           echo "Output files: $OUTPUT_FILES"
 
           mkdir -p verification_output
@@ -123,3 +174,72 @@ jobs:
             exit 1
           fi
 
+
+
+
+
+
+
+
+
+
+      - name: get .gds and .oas files, run example layout verification
+        id: run-script
+        run: |
+        
+          # if the action is being triggered after running python files, get resulting oas files from txt file
+          # github actions is not configured to detect files pushed from another action, thus we cannot use the method below
+          if [ -s "python-to-gds_oas.txt" ] && [ -n "$(cat python-to-gds_oas.txt)" ]; then
+            export FILES=$(cat python-to-gds_oas.txt)
+            IFS=' '
+            echo "" > python-to-gds_oas.txt
+             
+            # push empty text file to repo
+            git config --local user.email "${{ github.actor }}@users.noreply.github.com"
+            git config --local user.name "${{ github.actor }}"
+            git add python-to-gds_oas.txt
+            git commit -m "Emptying text file" 
+            git push
+
+          else
+            if [ "${{ github.event_name }}" = "pull_request" ]; then
+              # triggered on pull request, get all changed / added files from forked repo
+              export FILES=$(git diff --name-only --diff-filter=ACM FETCH_HEAD | grep -E '\.(gds|oas)$' | sed 's|^submissions/||')
+            else
+              # triggered push, locate the changed / added .gds and .oas files in the submission folder
+              export FILES=$(git diff --name-status --diff-filter=ACM --relative=submissions ${{ github.event.before }} ${{ github.sha }} submissions | grep -E '\.(gds|oas)$' | awk '{print $2}')
+            fi
+            IFS=$'\n'
+          fi
+
+          # print the names of the files
+          echo "Files for verification; $FILES"
+
+          files_with_errors=""
+        
+          # run verification on all files
+          for file in $FILES; do
+
+            echo "Running verification on $file"
+
+            output=$(python run_verification.py "submissions/$file")
+
+            # get number of errors
+            errors_from_output=$(echo "$output" | tail -n 1)
+
+            echo "$errors_from_output errors detected for $file"
+
+            # if file results in verification errors add to string files_with_errors
+            if [[ "$errors_from_output" -ge 1 ]]; then
+              files_with_errors+="$file, $errors_from_output errors. "
+              echo $files_with_errors >> $GITHUB_STEP_SUMMARY
+              echo $output >> $GITHUB_STEP_SUMMARY
+            fi
+
+            echo "Done verification on $file"
+          done
+
+          echo "files_with_errors=$files_with_errors" >> $GITHUB_ENV
+        # Don't run:
+        if: github.repository == 'octo-org/octo-repo-prod'
+

.github/workflows/run-yaml-verification.yml

@@ -12,6 +12,8 @@ on:
     branches:
       - '**'
   pull_request:
+    paths:
+      - 'submissions/**.yaml'
     branches:
       - '**'
 
@@ -59,6 +61,8 @@ jobs:
             echo "Running verification on $file"
 
             output=$(python run_yaml_verification.py "submissions/$file")
+            
+            echo $output  >> $GITHUB_STEP_SUMMARY
 
             # get number of errors
             #errors_from_output=$(echo "$output" | tail -n 1)
@@ -79,8 +83,11 @@ jobs:
         run: |
           if [ -z "$files_with_errors" ]; then
             echo "No errors detected."
+            echo "No errors detected." >> $GITHUB_STEP_SUMMARY
           else
-            echo "Errors detected: $files_with_errors"
+            echo "Errors detected: $files_with_errors" 
+            echo "Errors detected: $files_with_errors" >> $GITHUB_STEP_SUMMARY
+
             exit 1
           fi