Skip to content
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

Add upgrade instructions to README #687

Merged
merged 4 commits into from
Dec 2, 2019
Merged

Conversation

drwl
Copy link
Collaborator

@drwl drwl commented Nov 11, 2019

No description provided.

@drwl
Copy link
Collaborator Author

drwl commented Nov 11, 2019

@gingerlime if you want to review

README.rdoc Outdated
{change was added in #647}[link:https://github.com/ctran/annotate_models/pull/647] to change this. You {can read more here}[https://github.com/ctran/annotate_models/issues/663].

There are a few ways of fixing this.
1. If using CLI explicitly pass in models flag using +--models+

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perhaps the easiest way is to run rails g annotate:install ? :)

README.rdoc Outdated
@@ -50,6 +50,18 @@ It also annotates geometrical columns, geom type and srid, when using
Also, if you pass the -r option, it'll annotate routes.rb with the output of
<code>rake routes</code>.

== Upgrading to 3.X and annotate models not working?
In versions 2.7.X the annotate gem defaulted to annotating models if no arguments were passed in. The annotate gem by default would not allow for routes and models to be annotated together. A
{change was added in #647}[link:https://github.com/ctran/annotate_models/pull/647] to change this. You {can read more here}[https://github.com/ctran/annotate_models/issues/663].

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"A change was added in #647 to change this" -> "A change was added in #647" ? (just a suggestion to remove a bit of repetition...)

@gingerlime
Copy link

Thanks for pinging me. Just made a couple of small suggestions :)

@drwl
Copy link
Collaborator Author

drwl commented Nov 12, 2019

@gingerlime added some changes, wanna take another look?

README.rdoc Outdated Show resolved Hide resolved
@gingerlime
Copy link

gingerlime commented Nov 12, 2019

just spotted one small thing (potentially). Otherwise 👍

Sorry if this is a dumb question, but couldn't you detect if annotate is run without params and there's no rake task (and so it defaults to doing nothing), and then spit out a warning or something??

@drwl
Copy link
Collaborator Author

drwl commented Dec 2, 2019

@gingerlime sorry for the way delayed response, but yes can make that change. In the mean time will add this so folks can see this in the README.

@drwl drwl merged commit 5da7964 into develop Dec 2, 2019
@drwl drwl deleted the drwl/readme-upgrade-instructions branch December 2, 2019 04:05
peterfication pushed a commit to store2be/annotate_models that referenced this pull request Jan 20, 2020
Updates the readme to include a note about upgrading the gem to version 3 and that it can default to doing nothing.
vfonic pushed a commit to vfonic/annotate_models that referenced this pull request May 8, 2020
Updates the readme to include a note about upgrading the gem to version 3 and that it can default to doing nothing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants