Skip to content

Ignore header-less Markdown files in reference generation #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 30, 2025
Merged

Ignore header-less Markdown files in reference generation #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b84b95f
Ignore header-less Markdown files in reference generation
JohT Oct 30, 2025
d2f9fc7
Run documentation generation when its scripts changes
JohT Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/internal-report-reference-documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ on:
- "!analysis-results/*.md" # Ignore report reference documentation changes (endless loop prevention)
- ".github/workflows/internal-report-reference-documentation.yml" # Also run when this file was changed
- ".github/workflows/internal-commit-results" # Also run when the commit-results workflow was changed
- "documentation/analysis-reports-reference/**" # Also run when the report reference generation scripts were changed
pull_request:
branches:
- main
Expand All @@ -17,6 +18,7 @@ on:
- "!analysis-results/*.md" # Ignore report reference documentation changes (endless loop prevention)
- ".github/workflows/internal-report-reference-documentation.yml" # Also run when this file was changed
- ".github/workflows/internal-commit-results" # Also run when the commit-results workflow was changed
- "documentation/analysis-reports-reference/**" # Also run when the report reference generation scripts were changed

jobs:
generate-report-reference-documentation:
Expand Down
7 changes: 5 additions & 2 deletions documentation/analysis-reports-reference/generateJupyterReportReference.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,11 @@ echo "generateJupyterReportReference: Generating ${markdown_file}..."

# Loop through all Markdown files in the current directory
find . -type f -name "*.md" | sort | while read -r report_file; do
# Extract the first non-empty line that starts with '#'
report_file_header_line=$(grep -m 1 -e '^#\+.*' "${report_file}")
# Extract the first non-empty line that starts with one or more '#', allowing leading spaces
if ! report_file_header_line=$(grep -m 1 -e '^[[:space:]]*#\+[[:space:]]*.*' "${report_file}"); then
echo "generateJupyterReportReference: Warning: No header line found in ${report_file}, skipping."
continue
fi

# Remove leading '#' characters and trim leading/trailing spaces
description=$(echo "${report_file_header_line}" | sed -E 's/^#+\s*//')
Expand Down