Skip to content

Commit 1f891dc

Browse files
committed
docs: rename workflows for clarity
Before (industry jargon): - ci.yml → name: CI (what does CI mean?) - cd.yml → name: CD (what does CD mean?) After (descriptive verbs): - validate.yml → name: Validate (validates code quality) - release.yml → name: Release (publishes releases) New developer experience: - See 'validate.yml' → understands: this validates something - See 'release.yml' → understands: this releases something - No need to know CI/CD terminology Comments also explain: - What triggers each workflow - What each workflow does - Expected behavior
1 parent c7e49bd commit 1f891dc

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed
Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
1-
# .github/workflows/cd.yml
1+
# .github/workflows/release.yml
22
#
3-
# Continuous Delivery
4-
# Triggers on push to main
5-
# Publishes release if semantic-release detects changes
3+
# Publishes new releases automatically
4+
# Uses semantic-release to calculate version from commit messages
5+
#
6+
# Triggers:
7+
# - Push to main (after validation passes)
8+
#
9+
# Behavior:
10+
# - If commits follow Conventional Commits: creates new release
11+
# - If no release-worthy commits: skips silently
612
#
713

8-
name: CD
14+
name: Release
915

1016
on:
1117
push:
Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
# .github/workflows/ci.yml
1+
# .github/workflows/validate.yml
22
#
3-
# Continuous Integration
4-
# Runs on PR and push to main
5-
# Validates: test, lint, commit message, documentation
3+
# Validates code quality on every change
4+
# Runs: tests, linting, commit message format, documentation checks
5+
#
6+
# Triggers:
7+
# - Pull requests to main
8+
# - Direct pushes to main (safety net)
69
#
710

8-
name: CI
11+
name: Validate
912

1013
on:
1114
push:

0 commit comments

Comments
 (0)