Skip to content

Commit f223be3

Browse files
massongitclaude
andauthored
docs: sync action.yml description with README.md (#47)
Also add guidance to CLAUDE.md about keeping descriptions in sync. Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 7e6d87c commit f223be3

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

CLAUDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ This project maintains bilingual documentation:
1919
**Important**: When updating either readme file, the other must be updated accordingly.
2020
Keep both files synchronized with the same content in the appropriate language.
2121

22+
**Important**: README.md's description (line 5) must match action.yml's `description` field.
23+
When updating one, update the other accordingly. Note that action.yml's description should not have a trailing period.
24+
2225
## Setup
2326

2427
### Install pre-commit (Recommended)

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: "actions-workflow-metrics"
22
author: "Masaya Suzuki"
3-
description: "A custom GitHub Action that collects system metrics (CPU load, memory usage) during workflow execution and visualizes them as Mermaid charts"
3+
description: "A GitHub Actions for collecting system metrics during workflows and outputting Mermaid charts"
44
inputs:
55
interval_seconds:
66
description: "Interval between metrics collection in seconds"

0 commit comments

Comments
 (0)