Add ANNOTATERB_SKIP_ON_DB_TASKS ENV var to skip auto annotations
#40
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
Maimer
reviewed
Jun 11, 2023
| # This rake task was added by annotate_rb gem. | ||
|
|
||
| # Can set `ANNOTATERB_SKIP_ON_DB_TASKS` to be anything to skip this | ||
| if Rails.env.development? && ENV["ANNOTATERB_SKIP_ON_DB_TASKS"].nil? |
There was a problem hiding this comment.
Minor: but I might have gone with:
if Rails.env.development? && ENV["ANNOTATERB_SKIP_ON_DB_TASKS"]This is because you could set this environment variable to false and it would skip annotations, but probably not that big of a deal.
There was a problem hiding this comment.
I don't know if it's shell/environment specific but I think any values are interpreted as strings and not parsed.
# $ A_STRING=false pry
[1] pry(main)> ENV['A_STRING']
=> "false"This using zsh on a M1 mac.
There was a problem hiding this comment.
That's true, I guess that makes my comment not as relevant. (Also realized I had the boolean logic backwards and had included a !)
There was a problem hiding this comment.
No worries. I wasn't sure how ENV behaved, so when I first read your comment I thought this could be changed as well.
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.
In the old annotate gem, it used to be possible set
ANNOTATE_SKIP_ON_DB_MIGRATEtotrue|t|yes|y|1to skip the automatic annotation that happens after a Rails db task is run (e.g.bin/rails db:migrate). Note that the automatic annotation would only happen if a user installed the rails plugin (done viarails g annotate_rb:install).This behavior got removed when the dependency on ENV was removed. After some feedback, it seems like it's worth adding back to support special development setups or for checks in a CI pipeline.
Note: if you want the updated rake task, you'll have to rerun
rails g annotate_rb:install.