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

Update readme with v6.0.0 migration guide #1279

Closed
lavigne958 opened this issue Aug 18, 2023 · 8 comments
Closed

Update readme with v6.0.0 migration guide #1279

lavigne958 opened this issue Aug 18, 2023 · 8 comments
Assignees
Labels
Milestone

Comments

@lavigne958
Copy link
Collaborator

Overview

Update the main readme with a new temporary section with guidelines for migrating to v6.0.0

@alifeee alifeee added this to the 6.0.0 milestone Aug 18, 2023
@alifeee
Copy link
Collaborator

alifeee commented Aug 18, 2023

breaking changes:

@alifeee
Copy link
Collaborator

alifeee commented Sep 10, 2023

we should also

  • make sure all of these have deprecation warnings in v5

(should we?)

@lavigne958
Copy link
Collaborator Author

sure that's a good one once we add the documentation.

I started working on the first half of the documentation.

I'll open a pr now.

@alifeee
Copy link
Collaborator

alifeee commented Oct 25, 2023

I have ticked the boxes above that we have implemented into the guide. For the others, I have comments:

1 client -> http client #1190

I don't think this is needed in a migration guide. It is not a change, but an addition.

i.e., in v5 people created a client with service_account. In v6, they can create one and also specify an HTTP client.

2 refresh_last_update_time: added a new function #1255

Again, I don't think this is needed, as it is an addition. Additions can be viewed in the Release notes. Migration guide is only for breaking changes.

3 sort method change: in #1254

I don't know what this means

4 make sure Drive API is enabled/how to enable Drive API for client secret #1292

We went back on forcing the Drive API on people #1291. Thus, they no longer need to enable it.

5 Set maintain_size to True by default #1306

This is not yet implemented

@alifeee
Copy link
Collaborator

alifeee commented Oct 25, 2023

With #1333, there is a deprecation warning for each tick in the above list.

Now, we should ensure there is a deprecation warning in place before ticking an above item.

@lavigne958
Copy link
Collaborator Author

I have ticked the boxes above that we have implemented into the guide. For the others, I have comments:

1 client -> http client #1190

I don't think this is needed in a migration guide. It is not a change, but an addition.

i.e., in v5 people created a client with service_account. In v6, they can create one and also specify an HTTP client.

2 refresh_last_update_time: added a new function #1255

Again, I don't think this is needed, as it is an addition. Additions can be viewed in the Release notes. Migration guide is only for breaking changes.

3 sort method change: in #1254

I don't know what this means

We have an open issue about rewriting the sort method signature, to better type the arguments. #1090 but I think we can't do much about it.

4 make sure Drive API is enabled/how to enable Drive API for client secret #1292

We went back on forcing the Drive API on people #1291. Thus, they no longer need to enable it.

5 Set maintain_size to True by default #1306

This is not yet implemented

@lavigne958
Copy link
Collaborator Author

lavigne958 commented Nov 1, 2023

last fix to apply on release_6_0_ is the sort method signature change, we don't need a mention in the migration guide, I ran the tests and everything works like before. the method signature has not changed much though but it's slightly better I believe.

@lavigne958
Copy link
Collaborator Author

after this we should close this issue everything will be done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants