Skip to content

OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub

Add check for README.md correct case in docs/

Christophe Bliard90751c5b9e1b
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index 097e0d7f99f..4f20f7e14c7 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -13,7 +13,7 @@ permissions:
contents: read
jobs:
- docs-check:
+ docs-links-check:
name: Check internal links in documentation
runs-on: [ubuntu-latest]
steps:
@@ -22,3 +22,9 @@ jobs:
with:
bundler-cache: true
- run: bundle exec ./script/docs/check_links
+ docs-readme-case-check:
+ name: Check README.md case in documentation
+ runs-on: [ubuntu-latest]
+ steps:
+ - uses: actions/checkout@v5
+ - run: script/docs/check_readme_case
diff --git a/script/docs/check_readme_case b/script/docs/check_readme_case
new file mode 100755
index 00000000000..802a8c059f9
--- /dev/null
+++ b/script/docs/check_readme_case
@@ -0,0 +1,40 @@
+#!/usr/bin/env bash
+
+set -e
+
+# Script to check if README files in docs directory are all in uppercase (README.md)
+# Exits with error code 1 if any lowercase readme.md files are found
+
+DOCS_DIR="docs"
+ERRORS_FOUND=0
+
+readme_count=$(find "$DOCS_DIR" -iname "readme.md" -type f | wc -l)
+echo "Checking $((readme_count)) README file case in $DOCS_DIR/ directory..."
+
+# Find all readme.md files (case insensitive) in the docs directory
+while IFS= read -r -d '' file; do
+ # Get the filename without path
+ filename="${file##*/}"
+
+ # Check if the filename is not in uppercase
+ if [ "$filename" != "README.md" ]; then
+ echo "ERROR: Found lowercase readme file: $file"
+ echo " Expected: README.md (uppercase)"
+ ERRORS_FOUND=1
+ fi
+done < <(find "$DOCS_DIR" -iname "readme.md" -type f -print0)
+
+if [ $readme_count -eq 0 ]; then
+ echo "No README.md files found in $DOCS_DIR directory"
+ exit 0
+fi
+
+if [ $ERRORS_FOUND -eq 1 ]; then
+ echo ""
+ echo "🔴 Found $((readme_count)) README files, but some are not in uppercase."
+ echo "Please rename lowercase readme.md files to README.md"
+ exit 1
+else
+ echo "🟢 All $((readme_count)) README files are correctly named (uppercase)"
+ exit 0
+fi