Skip to content

ci: documentation: exclude drivers:api from README #2836

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

Open
amiclaus wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

ci: documentation: exclude drivers:api from README #2836

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions ci/documentation.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ COMMIT_RANGE="$1"
check_new_components_readme() {
echo_green "Checking for new drivers/projects and their README.rst files..."

# Excluded driver categories that don't require README.rst
local excluded_categories=("api" "platform")

# Get all added files only
git diff --name-only --diff-filter=A $COMMIT_RANGE | while read -r file; do
# Check if this is a file in drivers/ or projects/ directory
Expand All @@ -46,6 +49,14 @@ check_new_components_readme() {
if [ "$top_dir" = "drivers" ]; then
# For drivers: drivers/category/driver_name/...
local category=$(echo "$file" | cut -d'/' -f2)

# Skip excluded driver categories
for excluded in "${excluded_categories[@]}"; do
if [ "$category" = "$excluded" ]; then
continue 2
fi
done

component_dir=$(echo "$file" | cut -d'/' -f3)
local component_path="drivers/$category/$component_dir"
elif [ "$top_dir" = "projects" ]; then
Expand Down