Add rubocop and GitHub Actions to plugin generator #51822
Merged
Conversation
This file contains 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
rafaelfranca
force-pushed
the
plugin-github-actions
branch
2 times, most recently
from
a616634
to
5b26ff5
Compare
excid3
force-pushed
the
plugin-github-actions
branch
from
5b26ff5
to
a8fc27a
Compare
MatheusRich
reviewed
May 15, 2024
MatheusRich
reviewed
May 15, 2024
|
Overall looks good. Do we need a CHANGELOG entry and docs for this? |
|
Just saw @andrewn617 had refactored the database functionality for the app generator 2 days ago, so this is now updated and tests pass @rafaelfranca. There is one random failure in actioncable that seems unrelated. |
Could you squash your commits too when you're ready please? 🙇 |
When creating new Rails plugins, rubocop and GitHub Actions are now included to make linting and testing easier.
excid3
force-pushed
the
plugin-github-actions
branch
from
2611129
to
7594a73
Compare
rafaelfranca
added a commit
that referenced
this pull request
May 23, 2024
Add rubocop and GitHub Actions to plugin generator
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.
Motivation / Background
As I was working on my RailsConf 2024 talk, I realized the Rails plugin generator had not been updated to include the new rubocop and GitHub Actions files that ship with the app generator. These are particularly useful for plugin developers to make it easier to get started.
I spoke briefly with @rafaelfranca about making these additions which he agreed was a good idea. I also asked about brakeman, but he said that didn't make sense.
Detail
This Pull Request updates the plugin generator to include templates for GitHub Actions and rubocop. It also updated a couple of files to ensure they pass the rubocop linting.
I have kept these templates separate from the app templates as they are likely to diverge slightly over time.
Additional information
I decided not to include any functionality for testing CI against multiple Rails versions, but this could be added in the future.
Same for testing multiple Ruby versions. This could be added later.
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]