Skip to content

Commit 8070ef8

Browse files
committed
docs: Add descriptive comments to CI workflows
1 parent b4bb433 commit 8070ef8

3 files changed

Lines changed: 22 additions & 0 deletions

File tree

.github/workflows/issue-labeler.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# Name: Issue Labeler Workflow
2+
# Description: This workflow uses the github/issue-labeler action to automatically
3+
# add labels to new and edited issues based on keywords found in the
4+
# issue's title and body.
5+
# Purpose: Automate issue triage and categorization.
6+
# Triggers: An issue is opened or edited.
7+
18
name: Issue Labeler
29

310
on:

.github/workflows/release-please.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# Name: Release Please Workflow
2+
# Description: This workflow uses the googleapis/release-please-action to automate
3+
# the release process. It analyzes commits since the last release,
4+
# determines the next semantic version, and creates a pull request
5+
# with a changelog.
6+
# Purpose: Automate versioning and the creation of release pull requests.
7+
# Triggers: Push to the 'main' branch.
8+
19
name: release-please
210

311
on:

.github/workflows/validate.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# Name: Validate CLI Schema Workflow
2+
# Description: This workflow runs tests to validate the CLI schema against example
3+
# YAML files. It ensures that the schema and the validation logic are
4+
# working correctly.
5+
# Purpose: Maintain the integrity of the schema and its validation rules.
6+
# Triggers: Push or pull request involving changes to 'examples/*.yml' or 'schema/*.json'.
7+
18
name: Validate CLI Schema
29

310
on:

0 commit comments

Comments
 (0)