Skip to content

Upgrade dartdoc to 6.1.5 #6264

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

Closed
wants to merge 1 commit into from
Closed

Upgrade dartdoc to 6.1.5 #6264

wants to merge 1 commit into from

Conversation

isoos
Copy link
Collaborator

@isoos isoos commented Dec 8, 2022

No description provided.

@isoos isoos requested a review from jonasfj December 8, 2022 15:32
@isoos
Copy link
Collaborator Author

isoos commented Dec 8, 2022

/cc @srawlins - the JsonSerializable annotation lost its link (the golden file in the PR). Was that intentional or is it a bug?

@srawlins
Copy link
Member

srawlins commented Dec 8, 2022

Looking at the commit history, I think that is unintentional.

@srawlins
Copy link
Member

srawlins commented Dec 8, 2022

Ah, I'll have to look further back in the log to see what might have caused this. Going from 6.1.1 to 6.1.4.

@isoos
Copy link
Collaborator Author

isoos commented Dec 8, 2022

Checked the in-between versions, and it seems that it happened between 6.1.2 -> 6.1.3.

@srawlins
Copy link
Member

srawlins commented Dec 9, 2022

How can I reproduce this locally? Is there a dart run test that I can run?

@isoos
Copy link
Collaborator Author

isoos commented Dec 9, 2022

How can I reproduce this locally? Is there a dart run test that I can run?

After updating the version here:
https://github.com/dart-lang/pub-dev/blob/master/pkg/pub_dartdoc/pubspec.yaml#L11
I'm running this tool:
https://github.com/dart-lang/pub-dev/blob/master/pkg/pub_dartdoc/tool/update_golden_files.dart

@srawlins
Copy link
Member

srawlins commented Dec 9, 2022

Thanks! Bisecting leads me to dart-lang/dartdoc@46f5f0d. I tested locally both with 2.18 and 2.19.0-edge.29c3fea3bf3aee14c22e628748fafbd2c33cc792. Very strange...

@isoos
Copy link
Collaborator Author

isoos commented Dec 9, 2022

Bisecting leads me to dart-lang/dartdoc@46f5f0d.

Maybe the commit just before it?
dart-lang/dartdoc#3217

@srawlins
Copy link
Member

srawlins commented Dec 9, 2022

When I bisected, 51464a30fad5ff38f52f60602c0f02ff205edd0c was a good run, keeping the links intact.

@srawlins
Copy link
Member

srawlins commented Dec 9, 2022

OK, yes, this is because of the change in Dart 2.19-dev-something to change the hosted URL for packages in .dart_tool/package_config.json. I'm pretty sure this cross-linking will not be broken if this is all run with Dart 2.19. I'm unable to confirm this with dart pub get in various directories and the update_golden_files.dart script; but it looks to be the case from dartdoc's own tests.

@isoos
Copy link
Collaborator Author

isoos commented Dec 9, 2022

I'm pretty sure this cross-linking will not be broken if this is all run with Dart 2.19

Does that also mean that we shouldn't upgrade to 6.1.3 until we run on 2.19? (So we keep the links.)

@srawlins
Copy link
Member

srawlins commented Dec 9, 2022

I think I can fix-forward with a backwards-compatible fix. I cannot explain why I didn't conceive of this earlier, 🤦 .

dart-lang/dartdoc#3267

@isoos
Copy link
Collaborator Author

isoos commented Dec 13, 2022

I think I can fix-forward with a backwards-compatible fix. I cannot explain why I didn't conceive of this earlier, 🤦 .
dart-lang/dartdoc#3267

@srawlins: nice! What's the planned release schedule for it?

@srawlins
Copy link
Member

I have a bump to 6.1.5 here: dart-lang/dartdoc#3274 hope to release today.

@isoos
Copy link
Collaborator Author

isoos commented Dec 13, 2022

I have a bump to 6.1.5 here: dart-lang/dartdoc#3274 hope to release today.

It was fast, thank you! However, I've updated to 6.1.5, but it still has the same problem here.

@isoos isoos changed the title Upgrade dartdoc to 6.1.4 Upgrade dartdoc to 6.1.5 Dec 13, 2022
@srawlins
Copy link
Member

Rats, I must have been testing it wrong. Would it be costly to wait until pub.dev is running on Dart 2.19? Or some Dart 2.19 pre-release?

@jonasfj
Copy link
Member

jonasfj commented Dec 13, 2022

I see no reason to urgently update dartdoc in pub-dev, @isoos or am I missing something?

@isoos
Copy link
Collaborator Author

isoos commented Dec 13, 2022

Rats, I must have been testing it wrong. Would it be costly to wait until pub.dev is running on Dart 2.19? Or some Dart 2.19 pre-release?

This is not blocking and we are not in rush to get this on pub.dev. Take your time and thank you for looking into it!

@isoos
Copy link
Collaborator Author

isoos commented Dec 13, 2022

I'm closing the PR, and will re-create when dartdoc will get this fixed.

@isoos isoos closed this Dec 13, 2022
@isoos isoos deleted the dartdoc branch December 13, 2022 22:01
@isoos
Copy link
Collaborator Author

isoos commented Jan 31, 2023

Note: some packages are affected by the lack of this upgrade: #6378

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.

3 participants