-
Notifications
You must be signed in to change notification settings - Fork 4
Modernise dev environment & general upgrades #45
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
base: develop
Are you sure you want to change the base?
Conversation
@msxavi 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
Co-authored-by: msxavi <[email protected]>
Co-authored-by: msxavi <[email protected]>
Co-authored-by: msxavi <[email protected]>
Co-authored-by: msxavi <[email protected]>
|
f500f3f
to
59ed4dd
Compare
|
This pull request introduces comprehensive improvements to modernize the Patches Rails engine development environment, focusing on tooling, documentation, and compatibility. The changes enhance maintainability, streamline onboarding, and ensure compatibility with modern Ruby versions and Rails 8+.
🔄 CI/CD Modernization
Multi-Ruby Testing: Updated GitHub Actions workflow to test across Ruby versions 3.0–3.4 using a matrix strategy, expanding from the previous single Ruby 2.7 test. This ensures broader compatibility and catches version-specific issues early.
Workflow Optimization: Renamed
.github/workflows/specs.yml
to.github/workflows/ruby.yml
and updated to useactions/checkout@v4
. SonarQube scanning is now optimized to run only on Ruby 3.2 to reduce CI overhead while maintaining code quality checks.🛠 Development Environment
DevContainer Configuration: Added
.devcontainer/devcontainer.json
with Ruby 3.2 base image, essential VS Code extensions (Ruby, Solargraph, GitHub Copilot), and volume mounts for persistent bundle cache. This standardizes the development environment and simplifies onboarding for new contributors.AI Coding Guidelines: Created comprehensive documentation in
.github/copilot-instructions.md
detailing Patches's architecture, core components (Runner, TenantRunner, Workers, Notifier), configuration requirements, and development patterns. This enables AI tools to provide better assistance and helps developers understand the codebase structure.📦 Dependencies & Compatibility
Ruby Version Requirement: Updated
patches.gemspec
to require Ruby >= 3.0, dropping support for older Ruby versions while ensuring compatibility with modern environments.Factory Modernization: Switched from the deprecated
factory_girl
(> 4.5.0) to> 6.0), bringing testing dependencies up to date with current best practices.factory_bot_rails
(Rails 8+ Compatibility: Verified that worker serialization uses string keys and basic Ruby types, ensuring compatibility with Rails 8+ serialization changes. The existing Sidekiq integration patterns work seamlessly with modern Rails versions.
Quality Assurance
All existing tests continue to pass with 99.08% coverage maintained. The two pre-existing test failures related to Sidekiq argument format remain unchanged, confirming no regressions were introduced. Bundle installation works correctly across all supported Ruby versions.
Key Benefits:
Fixes #44.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.