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

Consider renaming the libraries #34

Closed
atn832 opened this issue Mar 6, 2020 · 7 comments
Closed

Consider renaming the libraries #34

atn832 opened this issue Mar 6, 2020 · 7 comments

Comments

@atn832
Copy link
Owner

atn832 commented Mar 6, 2020

As @suztomo pointed out in #26, those libraries are more fakes than mocks. Consider renaming the libraries to reflect that.

Source:

@atn832
Copy link
Owner Author

atn832 commented Apr 5, 2020

The steps would be:

  1. publish a last update on the old pub.dev project to mention it's deprecated, and include a link to the new project, as per Rename or delete pub packages dart-lang/sdk#12094.
  2. rename the classes from Mock to Fake, eg from FirestoreMock to FakeFirestore. In this repo there's only 9 of them. There are even fewer in the other projects.
  3. update the yaml and publish under the new name. Bump the version up to notify of the API change.
  4. rename the GitHub repository.

Rinse and repeat for all 4 libraries, then finally update blog posts or GitHub comments with the new urls.

Since most of these steps are mostly administrative and don't require coding, I'll do them all myself.

@suztomo what do you think of this process?

@suztomo
Copy link
Collaborator

suztomo commented Apr 5, 2020

I would do the followings (I have never published a library in pub.dev, nor renaming GitHub repository):

  1. Fork (not rename) GitHub repository with new name.
  2. In new repo, rename the class from Mock to Fake ...
  3. In new repo, update yaml and publish ...
  4. With the old repo, publish a last update ...
    This needs a link to a new pub.dev page
  5. Archive the old repo. This old GitHub repository serves to redirect users to new repository.

Alternatively, (1) rename GitHub repository and (2) then fork as old name are also good.

I do not have opinion on other libraries than cloud_firestore_mocks.

@atn832
Copy link
Owner Author

atn832 commented May 22, 2020

It turns out, renaming the repository is much more powerful than I thought. It will also handle web redirections and even git push redirects. So I can safely rename the repo.

https://help.github.com/en/github/administering-a-repository/renaming-a-repository

@suztomo
Copy link
Collaborator

suztomo commented May 22, 2020

Nice. Good to know. Thanks.

@atn832
Copy link
Owner Author

atn832 commented May 19, 2021

Renamed this repository, discontinued the old package and published the new one at https://pub.dev/packages/fake_cloud_firestore.

@atn832 atn832 closed this as completed May 19, 2021
@suztomo
Copy link
Collaborator

suztomo commented May 19, 2021

Thank you.

@atn832
Copy link
Owner Author

atn832 commented May 20, 2021

Thank you for your advice :)

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