forked from Pipelex/pipelex
-
Notifications
You must be signed in to change notification settings - Fork 1
156 lines (138 loc) · 6.59 KB
/
docs-update.yml
File metadata and controls
156 lines (138 loc) · 6.59 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
name: CodeBoarding Documentation update workflow
on:
schedule:
- cron: '0 20 * * 6' # Every Saturday at 8:00 PM UTC
workflow_dispatch:
inputs:
repository_url:
description: 'Repository URL to test with'
required: false
default: 'https://github.com/Pipelex/pipelex'
type: string
source_branch:
description: 'Source branch for generation'
required: false
default: 'main'
type: string
target_branch:
description: 'Target branch for pull request'
required: false
default: 'main'
type: string
output_format:
description: 'Output format for documentation'
required: false
default: '.md'
type: choice
options:
- '.mdx'
- '.md'
- '.rst'
output_directory:
description: 'Output directory for documentation files'
required: false
default: '.codeboarding'
type: string
jobs:
update-docs-action-usage:
runs-on: ubuntu-latest
timeout-minutes: 45
permissions:
contents: write
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0 # Required to access branch history
# Determine branches based on context
- name: Set branch variables
id: set-branches
run: |
if [ "${{ github.event_name }}" = "pull_request" ]; then
echo "source_branch=${{ github.head_ref }}" >> $GITHUB_OUTPUT
echo "target_branch=${{ github.base_ref }}" >> $GITHUB_OUTPUT
elif [ "${{ github.event.inputs.source_branch }}" != "" ] && [ "${{ github.event.inputs.target_branch }}" != "" ]; then
echo "source_branch=${{ github.event.inputs.source_branch }}" >> $GITHUB_OUTPUT
echo "target_branch=${{ github.event.inputs.target_branch }}" >> $GITHUB_OUTPUT
else
echo "source_branch=main" >> $GITHUB_OUTPUT
echo "target_branch=main" >> $GITHUB_OUTPUT
fi
- name: Fetch CodeBoarding Documentation
timeout-minutes: 30
id: codeboarding
uses: CodeBoarding/CodeBoarding-GHAction@0.1.2
with:
repository_url: ${{ github.event.inputs.repository_url || 'https://github.com/Pipelex/pipelex' }}
source_branch: ${{ steps.set-branches.outputs.source_branch }}
target_branch: ${{ steps.set-branches.outputs.target_branch }}
output_directory: ${{ github.event.inputs.output_directory || '.codeboarding' }}
output_format: ${{ github.event.inputs.output_format || '.md' }}
- name: Display Action Results
run: |
echo "Documentation files created: ${{ steps.codeboarding.outputs.markdown_files_created }}"
echo "JSON files created: ${{ steps.codeboarding.outputs.json_files_created }}"
echo "Documentation directory: ${{ steps.codeboarding.outputs.output_directory }}"
echo "JSON directory: ${{ steps.codeboarding.outputs.json_directory }}"
echo "Has changes: ${{ steps.codeboarding.outputs.has_changes }}"
# Check if we have any changes to commit
- name: Check for changes
id: git-changes
run: |
if [ -n "$(git status --porcelain)" ]; then
echo "has_git_changes=true" >> $GITHUB_OUTPUT
else
echo "has_git_changes=false" >> $GITHUB_OUTPUT
fi
# Copy CodeBoarding files to docs/pages/advanced-customization
- name: Copy CodeBoarding documentation to advanced-customization
if: steps.git-changes.outputs.has_git_changes == 'true' && steps.codeboarding.outputs.has_changes == 'true'
run: |
# Create docs/pages/advanced-customization directory if it doesn't exist
mkdir -p docs/pages/advanced-customization
# Log the files found in the CodeBoarding directory
echo "📁 Scanning CodeBoarding directory for .md files..."
ls -la .codeboarding/ || echo "⚠️ CodeBoarding directory not found"
# Copy all .md files from CodeBoarding to advanced-customization
copied_files_count=0
for file in .codeboarding/*.md; do
if [ -f "$file" ]; then
filename=$(basename "$file")
echo "✅ Copying: $filename to docs/pages/advanced-customization/"
cp "$file" "docs/pages/advanced-customization/$filename"
copied_files_count=$((copied_files_count + 1))
fi
done
# Summary logging
echo ""
echo "📊 File copy summary:"
echo " - Total .md files copied: $copied_files_count"
echo " - Destination: docs/pages/advanced-customization/"
# List final contents
if [ $copied_files_count -gt 0 ]; then
echo " - Files in destination:"
ls -la docs/pages/advanced-customization/*.md 2>/dev/null || echo " No .md files found in destination"
fi
echo "CodeBoarding documentation copied to docs/pages/advanced-customization/"
- name: Commit and push changes
if: steps.git-changes.outputs.has_git_changes == 'true' && steps.codeboarding.outputs.has_changes == 'true'
run: |
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add .
git commit -m "docs: update codeboarding documentation in advanced-customization
## 📚 Documentation Update
This commit contains updated documentation files fetched from the CodeBoarding service and copied to the advanced-customization section.
### 📊 Summary
- Documentation files created/updated: ${{ steps.codeboarding.outputs.markdown_files_created }}
- JSON files created/updated: ${{ steps.codeboarding.outputs.json_files_created }}
- Documentation directory: ${{ steps.codeboarding.outputs.output_directory }}/
- JSON directory: ${{ steps.codeboarding.outputs.json_directory }}/
- Output format: ${{ github.event.inputs.output_format || '.md' }}
- Repository analyzed: ${{ steps.codeboarding.outputs.repo_url }}
- Destination: docs/pages/advanced-customization/
The generated .md files have been automatically copied to the advanced-customization documentation section.
🤖 This commit was automatically generated by the CodeBoarding documentation update workflow."
git push