Skip to content

Migrate annotate to annotaterb#6962

Open
stefannibrasil wants to merge 1 commit into
rubyforgood:mainfrom
hexdevs:migrate-to-annotaterb
Open

Migrate annotate to annotaterb#6962
stefannibrasil wants to merge 1 commit into
rubyforgood:mainfrom
hexdevs:migrate-to-annotaterb

Conversation

@stefannibrasil
Copy link
Copy Markdown
Contributor

What github issue is this PR for, if any?

Related to #6955

What changed, and why?

annotate is not compatible with Rails > 8. There is a new fork gem that is actively maintained: annotaterb. Migrating to the fork allows us to upgrade Rails without regressions.

I updated the generated config file with the previous configuration from annotate. After running bundle exec annotaterb models, there are no file changes.

The difference from now on is that the commands to generate annotations have changed: annotaterb provides a CLI with updated options. For example, previously you would use bundle exec annotate, now one would use bundle exec annotaterb models. Learn more in https://github.com/drwl/annotaterb/blob/main/MIGRATION_GUIDE.md#command-line-differences

@github-actions github-actions Bot added the dependencies Touches dependency files label May 25, 2026
`annotate` is not compatible with Rails > 8. There is a new fork gem that is actively maintained: `annotaterb`. Migrating to the fork allows us to upgrade Rails without regressions.

I updated the generated config file with the previous configuration from `annotate`. After running `bundle exec annotaterb models`, there are no file changes.

The difference from now on is that the commands to generate annotations have changed: `annotaterb` provides a CLI with updated options. For example, previously you would use `bundle exec annotate`, now one would use `bundle exec annotaterb models`. Learn more in https://github.com/drwl/annotaterb/blob/main/MIGRATION_GUIDE.md#command-line-differences

Copy configuration from annotate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Touches dependency files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant