added comments to workflow files

TykTechnologies · Sep 12, 2024 · dcb3ed5 · dcb3ed5
1 parent 026071b
commit dcb3ed5
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/.github/workflows/tyk-dev.yaml → .github/workflows/tyk-dev.yml b/.github/workflows/tyk-dev.yaml → .github/workflows/tyk-dev.yml
@@ -1,5 +1,5 @@
-# Tyk Development Workflow -- execute validation, goverance and all platform engineering specific CICD requirements
-# for Tyk developed assets such as APIs and Policies
+# Tyk developer pipeline -- perform validation and linting of API definitions and policies if needed for dev env APIs.
+# This dev workflow will triggered if any PRs have been made specifically to the dev directory.
 name: Tyk Development Workflow
 
 # Execute workflow on dev pull requests

diff --git a/.github/workflows/tyk-lint.yml b/.github/workflows/tyk-lint.yml
@@ -62,15 +62,15 @@ jobs:
           fi
     
     # Tyk API Linting / Validation using Github Action Library
-    - name: Tyk Linter for Field Validation
+    - name: Lint / validation required field values
       uses: stoplightio/spectral-action@latest
       with:
         file_glob: ${{ env.environment }}/apis/api-*.json
         spectral_ruleset: ${{ env.environment }}/tykapi-ruleset.yaml
       continue-on-error: false
 
     # Tyk API Linting / Validation using JQ Library
-    - name: Tyk Linter for Auth Mechanism Validation
+    - name: Lint / validate required auth mechanisms
       env:
           ENV: ${{ env.environment }}
       run: |