Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitba403f2

Browse files
EdwardAngertclaude
andcommitted
docs: update GitHub Actions documentation
- Add more detailed descriptions of workflow components- Document status badge generation and thresholds- Clarify validation options and phases- Update preview generation details- Add examples of direct document links- Improve workflow composite action description🤖 Generated with [Claude Code](https://claude.ai/code)Co-Authored-By: Claude <noreply@anthropic.com>
1 parent00a4fb0 commitba403f2

File tree

3 files changed

+61
-30
lines changed

3 files changed

+61
-30
lines changed

‎.github/actions/docs-shared/action.yaml‎

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -448,9 +448,9 @@ runs:
448448
echo "status=success" >> $GITHUB_OUTPUT
449449
echo "result=" >> $GITHUB_OUTPUT
450450
451-
#Setup regex patternsforcross-references (escape special regex characters)
452-
MD_LINK_PATTERN='\[[^\]]+\]\([^)]+\)'
453-
ANCHOR_LINK_PATTERN='\(#[^)]+\)'
451+
#Patternsformatching markdown links and anchors
452+
MD_LINK_PATTERN='\[.*\](.*)'
453+
ANCHOR_LINK_PATTERN='(#[^)]*)'
454454
455455
# Get the base commit to compare against
456456
BASE_SHA=$(git merge-base HEAD origin/main || git rev-parse HEAD~1)
@@ -474,11 +474,22 @@ runs:
474474
475475
# Check if file exists in commit
476476
if git cat-file -e $commit:$file 2>/dev/null; then
477-
# Extract and process headings with error handling
478-
git show $commit:$file 2>/dev/null | grep-E'^#{1,6}' |
477+
# Extract and process headings
478+
git show $commit:$file 2>/dev/null | grep '^#' |
479479
while IFS= read -r line; do
480-
echo "$line" | sed 's/^#* //' | tr -d '`' |
481-
tr '[:upper:]' '[:lower:]' | sed 's/[^a-z0-9 -]//g' | sed 's/ /-/g' || echo ""
480+
# Step-by-step processing for maximum reliability
481+
# 1. Remove initial #s and leading space
482+
cleaned=$(echo "$line" | sed 's/^#* //')
483+
# 2. Remove backticks
484+
cleaned=$(echo "$cleaned" | tr -d '`')
485+
# 3. Convert to lowercase
486+
cleaned=$(echo "$cleaned" | tr '[:upper:]' '[:lower:]')
487+
# 4. Remove special characters
488+
cleaned=$(echo "$cleaned" | sed 's/[^a-z0-9 -]//g')
489+
# 5. Replace spaces with dashes
490+
cleaned=$(echo "$cleaned" | sed 's/ /-/g')
491+
# Output the result
492+
echo "$cleaned"
482493
done
483494
else
484495
echo "File not found in commit: $file@$commit" >&2
@@ -594,11 +605,17 @@ runs:
594605
echo $CHANGED_FILES | jq -c '.[]' | while read -r file_path; do
595606
file_path=$(echo $file_path | tr -d '"')
596607
if [[ $file_path == ${{ inputs.docs-dir }}/* ]] && [[ $file_path == *.md ]]; then
597-
# Extract path for URL (remove .md and docs/ prefix)
598-
url_path=$(echo "$file_path" | sed 's/^${{ inputs.docs-dir }}\///' | sed 's/\.md$//')
608+
# Extract path for URL using parameter expansion
609+
DOCS_DIR="${{ inputs.docs-dir }}"
610+
# Remove docs dir prefix and .md extension
611+
temp_path="${file_path#$DOCS_DIR/}"
612+
url_path="${temp_path%.md}"
613+
614+
# Generate the full preview URL
599615
doc_url="https://coder.com/docs/@$BRANCH/$url_path"
600-
# Get file title from first heading or filename
601-
title=$(head -20 "$file_path" | grep -m 1 "^# " | sed 's/^# //' || basename "$file_path" .md)
616+
617+
# Get file title from first heading or fallback to filename
618+
title=$(head -20 "$file_path" | grep "^# " | head -1 | cut -c 3- || basename "$file_path" .md)
602619
DOC_LINKS="${DOC_LINKS}- [$title]($doc_url)\n"
603620
fi
604621
done

‎.github/docs/README.md‎

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,28 @@ jobs:
2424
contents:read
2525
pull-requests:write
2626
with:
27-
lint-markdown:true
28-
check-format:true
29-
check-links:true
30-
check-cross-references:true
31-
lint-vale:true
32-
generate-preview:true
33-
post-comment:true
34-
fail-on-error:false
27+
# Validation options
28+
lint-markdown:true# Run markdownlint-cli2
29+
check-format:true# Check markdown table formatting
30+
check-links:true# Check for broken links with lychee
31+
check-cross-references:true# Detect broken internal references
32+
lint-vale:true# Run Vale style checking
33+
34+
# Output options
35+
generate-preview:true# Generate preview URLs
36+
post-comment:true# Post results as PR comment
37+
fail-on-error:false# Continue workflow on validation errors
3538
```
3639
3740
### Post-Merge Link Checking
3841
39-
The`docs-link-check.yaml` workflow runs after merges to main and on a weekly schedule to check for broken links andcreate GitHub issues automatically:
42+
The`docs-link-check.yaml` workflow runs after merges to main and on a weekly schedule to check for broken links andcross-references:
4043

4144
-Runs after merges to main that affect documentation
4245
-Runs weekly on Monday mornings
43-
-Creates GitHub issues with broken link details
44-
-Sends Slack notifications when issues are found
46+
-Uses lychee for robust link checking
47+
-Detects broken internal cross-references
48+
-Creates GitHub issues with detailed error information and fix guidance
4549

4650
## Features
4751

@@ -81,40 +85,50 @@ The documentation workflow is designed for maximum efficiency using a phase-base
8185

8286
### Phase 4: Preview Generation
8387
-Generate preview URLs for documentation changes
84-
-Build links to new documentation
88+
-Create direct links to specific changed documents
89+
-Extract document titles from markdown headings
8590

8691
### Phase 5: Results Aggregation
8792
-Collect results from all validation steps
8893
-Normalize into a unified JSON structure
8994
-Calculate success metrics and statistics
90-
-Generatesummary badge
95+
-Generatestatus badge based on success percentage
9196

9297
### Phase 6: PR Comment Management
9398
-Find existing comments or create new ones
9499
-Format results in a user-friendly way
95100
-Provide actionable guidance for fixing issues
101+
-Include direct links to affected documents
96102

97103
## Unified Results Reporting
98104

99-
The workflownowaggregates all validation results into a single JSON structure:
105+
The workflow aggregates all validation results into a single JSON structure:
100106

101107
```json
102108
[
103109
{
104-
"name": "markdown-lint",
105-
"status": "success|failure",
106-
"output": "Raw output fromthe validationtool",
110+
"name": "Markdown Linting",
111+
"status": "success|failure|warning",
112+
"details": "Details aboutthe validationresult",
107113
"guidance": "Human-readable guidance on how to fix",
108114
"fix_command": "Command to run to fix the issue"
109115
},
110116
// Additional validation results...
111117
]
112118
```
113119

120+
### Status Badge Generation
121+
122+
Results are automatically converted to a GitHub-compatible badge:
123+
124+
-✅ **Passing**:100% of validations pass
125+
-⚠️ **Mostly Passing**:≥80% of validations pass
126+
-❌ **Failing**:<80% of validations pass
127+
114128
### Benefits of Unified Reporting:
115129

116130
1. **Consistency**:All validation tools report through the same structure
117-
2. **Integration**:JSON output can be easily consumed by other tools or dashboards
131+
2. **Visibility**:Status badge clearly shows overall health at a glance
118132
3. **Statistics**:Automatic calculation of pass/fail rates and success percentages
119133
4. **Diagnostics**:All validation results in one place for easier debugging
120134
5. **Extensibility**:New validators can be added with the same reporting format

‎.github/docs/actions/docs-shared/action.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name:'Docs Shared Action'
2-
description:'A composite actionproviding shared functionality for docs-related workflows'
2+
description:'Aunified, phase-basedcomposite actionfor documentation validation and reporting'
33
author:'Coder'
44

55
inputs:

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp