How should I set up a CI job to ensure that annotations are up to date? about annotate_models

[ktimothy]

You can use --frozen flag. If anything needs annotation, the command with return exit status 1, failing a pipeline.

Keep in mind that you will need a database connection for annotate to run.

[TiesWestendorp]

You can use --frozen flag. If anything needs annotation, the command with return exit status 1, failing a pipeline.

Awesome, I was using annotate; git diff --exit-code before this. This is much cleaner.

Keep in mind that you will need a database connection for annotate to run.

This would be nice to mention in README.md to be honest. Additionally, the auto-generated rake task was only generated for Rails.env.development?, so not for Rails.env.test?, which took a while for me to figure out. Maybe a CI/setup paragraph would be nice?

[ndbroadbent]

Awesome that worked, thanks! I switched from rake annotate_models | grep 'Model files unchanged.' to bundle exec annotate --models --frozen.