feat(update-checker): add validation improvements, fixes #92 #94
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add comprehensive checks to ensure add-on quality standards: - Validate all files end with trailing newline (POSIX compliance) - Check workflows have at least 2 paths-ignore configurations - Require ddev_version_constraint >= v1.24.10 - Detect #ddev-nodisplay tag usage in install.yaml The version constraint check now uses semantic version comparison instead of regex patterns, properly handling all version formats including edge cases like v1.1.1, v1.24.11, v2.0.0, etc. Removed pipefail to prevent script from failing when grep finds no matches in normal validation scenarios. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Enhance validation to ensure test files follow best practices: - Check for required environment variables (GITHUB_ENV, DDEV_NONINTERACTIVE, DDEV_NO_INSTRUMENTATION) - Verify GITHUB_REPO is defined - Ensure bats_load_library is used for proper test setup Add file formatting validation: - Detect whitespace-only lines (lines with only spaces/tabs) - Rename check_trailing_newline to check_file_formatting for clarity These checks help maintain consistent test quality and file formatting across DDEV add-ons. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Test data files may intentionally contain non-standard formatting for testing purposes, so they should be excluded from validation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Changes: - Only validate detailed requirements if tests/test.bats exists - Allow alternative test file names (e.g., tests/drupal11-unified.bats) - Add info_messages array for non-error notifications - Display INFO messages with consistent bullet format - Show informational message when using non-standard test files This makes the checker more flexible for projects with custom test file structures while maintaining strict validation for the standard test.bats file. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Define minimum DDEV version (1.24.10) as local variables in the check_install_yaml function instead of hardcoding it multiple times. This makes it easier to update the minimum version requirement in the future by changing values in one place. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Issue
How This PR Solves The Issue
Add comprehensive checks to ensure add-on quality standards:
paths-ignore:configurationsddev_version_constraint >= v1.24.10#ddev-nodisplaytag usage ininstall.yamltests/test.batstests/test.batsbats_load_libraryis used for proper test setup intests/test.batstests/test.bats existstests/drupal11-unified.bats)The version constraint check now uses semantic version comparison instead of regex patterns, properly handling all version formats including edge cases like v1.1.1, v1.24.11, v2.0.0, etc.
Removed pipefail to prevent script from failing when grep finds no matches in normal validation scenarios.
🤖 Generated with Claude Code
Manual Testing Instructions
Run this in some add-on directory:
curl -fsSL https://raw.githubusercontent.com/ddev/ddev-addon-template/refs/heads/20251119_stasadev_update_checker/.github/scripts/update-checker.sh | bashAutomated Testing Overview
Release/Deployment Notes