-
Notifications
You must be signed in to change notification settings - Fork 33
Add a motor test sub-application requirements #596
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds automated management for ArduPilot motor diagram SVGs and reorganizes image assets, along with updates to packaging, tests, and documentation.
- Introduces
scripts/download_motor_diagrams.py
plus a GitHub Actions workflow and manual update instructions. - Refactors code and installer scripts to use a new
images/
directory for icons and SVGs. - Updates tests and documentation (
ARCHITECTURE.md
,.github/*
) to reflect the new feature and asset paths.
Reviewed Changes
Copilot reviewed 10 out of 55 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
windows/ardupilot_methodic_configurator.iss | Updated installer to deploy icons/SVGs from images/ |
ardupilot_methodic_configurator/backend_filesystem_program_settings.py | Changed icon/logo paths to images/ subdirectory |
tests/test_backend_filesystem_program_settings.py | Updated tests to expect new images/ directory paths |
scripts/download_motor_diagrams.py | Added script to download motor diagrams from docs |
.github/workflows/update_motor_diagrams.yml | CI workflow to run the download script weekly |
.github/instructions/update_motor_diagrams.md | Manual and AI guidelines for updating motor diagrams |
.github/copilot-instructions.md | Added link to motor diagram update instructions |
ARCHITECTURE_motor_test.md | New detailed architecture for the motor test sub-app |
ARCHITECTURE.md | Registered the motor test sub-app and download script |
SetupDeveloperPC.sh | Updated desktop entry icon path to images/ directory |
Comments suppressed due to low confidence (2)
scripts/download_motor_diagrams.py:78
- Add unit tests for
download_motor_diagrams()
, mockingurllib.request.urlretrieve
, directory creation, and URL validation to ensure the new script is covered by pytest.
def download_motor_diagrams() -> None:
tests/test_backend_filesystem_program_settings.py:18
- [nitpick] Instead of using a backslash for import continuation, wrap the import in parentheses for better readability and to satisfy PEP 8.
from ardupilot_methodic_configurator.backend_filesystem_program_settings import \
☂️ Python Coverage
Overall Coverage
New Files
Modified Files
|
Test Results 2 files ± 0 2 suites ±0 1m 42s ⏱️ ±0s Results for commit 3655c4c. ± Comparison against base commit 78bcf75. This pull request removes 17 and adds 159 tests. Note that renamed tests count towards both.
♻️ This comment has been updated with latest results. |
2db9348
to
bec06a6
Compare
66bfa58
to
f111ef3
Compare
Including BDD tests
f111ef3
to
b431f2b
Compare
b431f2b
to
3655c4c
Compare
This pull request introduces a new feature for managing and updating ArduPilot motor diagram SVG files, along with several related changes to the codebase and documentation. The key updates include adding a script for downloading motor diagrams, integrating it into the CI/CD pipeline, updating file paths for consistency, and enhancing documentation to support this feature.
New Feature: Motor Diagram Management
scripts/download_motor_diagrams.py
, to automate downloading motor diagram SVG files from the ArduPilot documentation. This script includes error handling and validation for secure URL downloads..github/workflows/update_motor_diagrams.yml
, to periodically run the script and create pull requests with updated diagrams..github/instructions/update_motor_diagrams.md
, providing detailed manual and automated update guidelines for motor diagrams.Documentation Updates
.github/copilot-instructions.md
to include a link to the new motor diagrams update instructions.ARCHITECTURE.md
to document the motor test sub-application, its integration with motor diagrams, and the autogenerateddownload_motor_diagrams.py
script. [1] [2] [3] [4]Codebase Refactoring
backend_filesystem_program_settings.py
to use a newimages
directory for better organization.SetupDeveloperPC.sh
to reflect the newimages
directory.Testing Enhancements
tests/test_backend_filesystem_program_settings.py
to reflect the changes in file paths for the application icon and logo. [1] [2]These changes collectively improve the maintainability and automation of motor diagram updates while enhancing the organization and clarity of the codebase and documentation.