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

Planning to change PT-AT from runtime dependency to dev. dependency #7

Closed
jaredbeck opened this issue Aug 14, 2018 · 4 comments
Closed

Comments

@jaredbeck
Copy link
Collaborator

Getting ready for the release of PT 10, seemed like a good time for this planned change.

paper-trail-gem/paper_trail@db9c392

PT will keep PT-AT as a dev. dependency and continue to run all existing association-tracking related tests for as long as is practical. The only change here is that PT-AT users will have to add it to their own Gemfile.

Any concerns? Any further instructions we should include in the PT 10.0.0 changelog entry?

@westonganger
Copy link
Owner

westonganger commented Aug 14, 2018

Well dropping the runtime dependency happened quicker then expected... However my only concern is that this change does not happen silently. Should there be any pre-removal notice during the 10.x series, kind of like a deprecation? This could look like the following on your end.

module PaperTrail
  module Config
    PT_AT_ERROR = 'Please add PT-AT gem to your Gemfile'

    def track_associations=(val)
      raise PT_AT_ERROR
    end

    def track_associations?
      raise PT_AT_ERROR
    end
  end
end

@jaredbeck
Copy link
Collaborator Author

.. dropping the runtime dependency happened quicker then expected...

Yeah, it's only been three months, but we're doing a major version release so it's a good opportunity to make breaking changes.

However my only concern is that this change does not happen silently.

It's in the changelog, but yeah people often don't read changelogs.

Should there be any pre-removal notice during the 10.x series, kind of like a deprecation? This could look like the following on your end.

Sounds good. Want to make a PR?

So, PT-AT has to be required after PT, right? So, will the order in the Gemfile matter? Should we tell people to put PT-AT after PT in their Gemfile?

@westonganger
Copy link
Owner

Sure Ill add the PR.

No Gemfile order will not matter. PT is a dependency of PT-AT so it will always be required before it.

@jaredbeck
Copy link
Collaborator Author

Closing via paper-trail-gem/paper_trail#1141. Thanks!

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

No branches or pull requests

2 participants