chore: Adjust name of acceptance test runner workflow (#1814)

* chore: adjust name of acceptance test runner workflow

* move comment describing workflow to the top

* include description to all active workflows

.github/workflows/acceptance-tests-runner.yml

@@ -1,8 +1,9 @@
-name: 'Acceptance Tests'
+name: 'Acceptance Tests Execution'
 run-name: 'Acceptance Tests Execution ${{ inputs.test_group }}'
 
+# Called by acceptance-tests.yml workflow to run acceptance tests. Input and secret variables are defined by the caller depending if `dev` or `qa` cloud env is used.
 on:
-  workflow_call: # called by acceptance-tests.yml workflow making use of correct env variables depending if `dev` or `qa` is used.
+  workflow_call:
     inputs:
       terraform_version:
         description: 'Terraform version to use, e.g. 1.6.x, empty for latest'     

.github/workflows/acceptance-tests.yml

@@ -1,6 +1,7 @@
 name: 'Acceptance Tests'
 run-name: 'Acceptance Tests ${{ inputs.atlas_cloud_env }} ${{ inputs.test_group }}'
 
+# Used for running acceptance tests, either triggered manually or called by other workflows. 
 on:
   workflow_dispatch:
     inputs:

.github/workflows/cleanup-test-env.yml

@@ -1,5 +1,6 @@
 name: 'Cleanup test env'
 
+# Cleans up our atlas cloud dev and qa organizations used for testing.
 on:
   workflow_dispatch: # workflow can be run manually
   workflow_call: # workflow runs from Test Suite

.github/workflows/code-health.yml

@@ -1,5 +1,6 @@
 name: 'Code Health'
 
+# Set of validations run on each pull request and merged commits to master.
 on:
   push:
     branches:

.github/workflows/examples.yml

@@ -1,4 +1,6 @@
 name: Examples Checks
+
+# Runs terraform linting and validation commands when examples are modified. Triggered in pull requests and merged commits to master.
 on:
   push:
     branches:

.github/workflows/issues.yml

@@ -1,6 +1,7 @@
 ---
   name: Create JIRA ticket for new issues
 
+  # Creates and updates jira tickets that sync with GitHub Issues events.
   on:
     issues:
       types: [opened, reopened, closed]

.github/workflows/migration-tests.yml

@@ -1,5 +1,6 @@
 name: 'Migration Tests'
 
+# Used for running migration tests, either triggered manually or called by other workflows.
 on:
   workflow_dispatch:
     inputs:

.github/workflows/pull-request-lint.yml

@@ -1,4 +1,6 @@
 name: pull-request-lint
+
+# Run validations over pull request titles while also adding appropriate labels.
 on:
   pull_request:
     types:

.github/workflows/release.yml

@@ -1,6 +1,7 @@
 name: 'New Release'
 run-name: 'Release ${{ inputs.version_number }}'
 
+# Used for creating a new release. This workflow will run qa acceptance tests, create a new tag, and generate the release with GoReleaser.
 on:
   workflow_dispatch:
     inputs:

.github/workflows/stale.yml

@@ -1,5 +1,7 @@
 ---
 name: 'Stale issues and PRs handler'
+
+# Handles stale github issues and pull requests.
 on:
   workflow_dispatch:
   schedule:

.github/workflows/test-suite.yml

@@ -1,5 +1,6 @@
 name: 'Test Suite'
 
+# Runs acceptance and migrations tests with a set of terraform versions and provider versions (used for migration tests). This worflow is scheduled daily, but can also be run manually.
 on:
   workflow_dispatch:
     inputs:

.github/workflows/update-sdk.yml

@@ -1,4 +1,6 @@
 name: Update Atlas Go SDK
+
+# Checks if a new Atlas Go SDK version is available and creates a pull request adjusting version in codebase. Runs once per week and can be triggered manually.
 on:
  schedule:
    - cron: "30 8 * * TUE" # Every Tuesday at 8:30 AM