Skip to content

Commit 1c156cd

Browse files
ivanmilevtuesivanmilevtues
committed
Workflow update
1 parent 1799190 commit 1c156cd

File tree

1 file changed

+34
-62
lines changed

1 file changed

+34
-62
lines changed

‎.github/workflows/docs-update.yml‎

Lines changed: 34 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ on:
3030
output_directory:
3131
description: 'Output directory for documentation files'
3232
required: false
33-
default: 'docs/api-reference/auto-generated'
33+
default: '.codeboarding'
3434
type: string
3535

3636
jobs:
@@ -70,7 +70,7 @@ jobs:
7070
repository_url: ${{ github.event.inputs.repository_url }}
7171
source_branch: ${{ steps.set-branches.outputs.source_branch }}
7272
target_branch: ${{ steps.set-branches.outputs.target_branch }}
73-
output_directory: ${{ github.event.inputs.output_directory || 'docs/api-reference/auto-generated' }}
73+
output_directory: ${{ github.event.inputs.output_directory || '.codeboarding' }}
7474
output_format: ${{ github.event.inputs.output_format || '.mdx' }}
7575

7676
- name: Display Action Results
@@ -91,70 +91,42 @@ jobs:
9191
echo "has_git_changes=false" >> $GITHUB_OUTPUT
9292
fi
9393
94-
# Update documentation to include the generated files
95-
- name: Update documentation structure with generated docs
94+
# Append generated MDX files to development.mdx
95+
- name: Append generated docs to development.mdx
9696
if: steps.git-changes.outputs.has_git_changes == 'true' && steps.codeboarding.outputs.has_changes == 'true'
9797
run: |
98-
# Install jq for JSON manipulation
99-
sudo apt-get update && sudo apt-get install -y jq
100-
101-
# Update docs.json to include auto-generated files in API Reference
98+
# Check if the output directory exists and has .mdx files
10299
if [ -d "${{ steps.codeboarding.outputs.output_directory }}" ]; then
103-
# Create a list of generated files for docs.json
104-
generated_files=""
105-
find "${{ steps.codeboarding.outputs.output_directory }}" -name "*.mdx" -type f | while read file; do
106-
# Get relative path from docs root without extension
107-
rel_path=$(echo "$file" | sed 's|^docs/||' | sed 's|\.mdx$||')
108-
if [ -z "$generated_files" ]; then
109-
generated_files="\"$rel_path\""
110-
else
111-
generated_files="$generated_files,\"$rel_path\""
112-
fi
113-
echo "$rel_path" >> generated_files_list.txt
114-
done
100+
# Add a section header for auto-generated documentation
101+
echo "" >> docs/development.mdx
102+
echo "## Auto-Generated API Documentation" >> docs/development.mdx
103+
echo "" >> docs/development.mdx
104+
echo "The following documentation was automatically generated from the codebase:" >> docs/development.mdx
105+
echo "" >> docs/development.mdx
115106
116-
# Update docs.json to include auto-generated files
117-
if [ -s generated_files_list.txt ]; then
118-
# Create a new group for auto-generated docs
119-
temp_json=$(mktemp)
120-
jq --argjson new_group '{
121-
"group": "Auto-Generated API Documentation",
122-
"pages": []
123-
}' '
124-
.navigation[0].groups |= map(
125-
if .group == "API Reference" then
126-
.groups += [$new_group] |
127-
.groups[-1].pages = (input | split("\n") | map(select(length > 0)))
128-
else . end
129-
)' docs/docs.json generated_files_list.txt > "$temp_json"
130-
131-
# If the above doesn't work, try a simpler approach
132-
if [ $? -ne 0 ]; then
133-
# Simple insertion: add auto-generated files to existing API Reference group
134-
while read -r file_path; do
135-
if [ -n "$file_path" ]; then
136-
jq --arg path "$file_path" '
137-
(.navigation[] | select(.tab == "API Reference") | .groups[] | select(.group == "API Reference") | .pages) += [$path]
138-
' docs/docs.json > "$temp_json" && mv "$temp_json" docs/docs.json
139-
fi
140-
done < generated_files_list.txt
141-
else
142-
mv "$temp_json" docs/docs.json
107+
# Find all .mdx files in the output directory and append their content
108+
find "${{ steps.codeboarding.outputs.output_directory }}" -name "*.mdx" -type f | sort | while read file; do
109+
if [ -f "$file" ]; then
110+
filename=$(basename "$file" .mdx)
111+
112+
# Add a header for each file
113+
echo "### $(echo "$filename" | sed 's/_/ /g' | sed 's/\b\w/\U&/g')" >> docs/development.mdx
114+
echo "" >> docs/development.mdx
115+
116+
# Append the content of the file (skip frontmatter if present)
117+
if head -n 1 "$file" | grep -q "^---"; then
118+
# Skip frontmatter (from first --- to second ---)
119+
sed -n '/^---$/,/^---$/d; /^---$/,$p' "$file" >> docs/development.mdx
120+
else
121+
# No frontmatter, append entire file
122+
cat "$file" >> docs/development.mdx
123+
fi
124+
125+
echo "" >> docs/development.mdx
126+
echo "---" >> docs/development.mdx
127+
echo "" >> docs/development.mdx
143128
fi
144-
145-
rm -f generated_files_list.txt
146-
fi
147-
148-
# Update development.mdx to mention auto-generated documentation
149-
# Insert before the Project Structure section
150-
sed -i '/## Project Structure/i \
151-
## Auto-Generated API Documentation\
152-
\
153-
This project includes automatically generated API documentation files created by the CodeBoarding documentation workflow. These files provide detailed documentation for the codebase and are updated automatically when changes are made to the source code.\
154-
\
155-
The auto-generated documentation files are located in the **API Reference** section of this documentation site under "Auto-Generated API Documentation".\
156-
\
157-
' docs/development.mdx
129+
done
158130
fi
159131
160132
- name: Create Pull Request
@@ -175,7 +147,7 @@ The auto-generated documentation files are located in the **API Reference** sect
175147
- **Output format**: `${{ github.event.inputs.output_format || '.mdx' }}`
176148
- **Repository analyzed**: `${{ steps.codeboarding.outputs.repo_url }}`
177149
178-
The generated .mdx files have been automatically integrated into the development documentation.
150+
The generated .mdx files have been automatically appended to the development documentation.
179151
180152
🤖 This PR was automatically generated by the CodeBoarding documentation update workflow.
181153
branch: docs/codeboarding-update

0 commit comments

Comments
 (0)