Skip to content

Bump version to 8.0.0 #3583

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

Merged
merged 2 commits into from
Nov 17, 2023
Merged

Bump version to 8.0.0 #3583

merged 2 commits into from
Nov 17, 2023

Conversation

kallentu
Copy link
Member

@kallentu kallentu commented Nov 17, 2023

I tried my best with the CHANGELOG. Let me know if you'd want any changes!

  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

@kallentu kallentu requested a review from srawlins November 17, 2023 01:10
@parlough
Copy link
Member

Looking at all the API breaking changes, shouldn't this be 8.0.0?

@srawlins
Copy link
Member

After 7.0.0 I have been treating dartdoc as if it is all internal API; nothing public (lots of "public" API was broken in 7.0.1 and 7.0.2). That's not strictly true as we export plenty from libraries in lib/ outside lib/src/, so I guess step 1 would be to stop exporting from lib/. I'd be ok with either. We can call this 7.0.3 or 8.0.0.

@parlough
Copy link
Member

parlough commented Nov 17, 2023

I don't know how many developers use package:dartdoc but I think if it's going to keep being published on pub, its version should match what has changed. It's only fair to any potential users or even explorers of the package. I think they'd much rather have a major version that increases every release than pub solves upgrading them to incompatible dependencies.

If it's planned to discontinue publishing, do consider making this one final release as 8.0.0. Then adding to the README details about the discontinuation, publishing 8.0.1, then discontinuing it properly on pub.

If it's planned to just publish solely as a CLI tool, then consider making this one final 8.0.0 release with public APIs and then update to 9.0.0 and remove all exported APIs.

@srawlins
Copy link
Member

I publish for customers to use it via dart run dartdoc. Flutter uses this to generate flutter.api.dev, and other customers can use it for a tool that updates with a higher cadence than the Dart SDK stable releases.

@parlough
Copy link
Member

parlough commented Nov 17, 2023

That makes sense and I know a few other cases of this use too. However that likely was not clear to many users, since it's not really stated anywhere apparent. Also the changelog previously tracked breaking library changes. So to transition to a world where that is clear, how about the following?

  1. Release this version as 8.0.0, with a note that the next release will not be intended for use a library.
  2. Update the version to 9.0.0.
  3. Clarify in the README this package is intended for use as a CLI tool.
  4. Stop exporting most public libraries (edit: or deprecate them).
  5. Change libraries to our heart's content :)

@srawlins
Copy link
Member

I think that's a fine plan. We can @Deprecate() the exports in the lib/dartdoc.dart ASAP as well. (It could be in 8.0.0, but Kallen is trying to get a release out to Flutter, so not high priority.)

@kallentu kallentu changed the title Bump version to 7.0.3 (really) Bump version to 8.0.0 Nov 17, 2023
@srawlins
Copy link
Member

8.0.0 LGTM

@kallentu kallentu merged commit d7723c9 into main Nov 17, 2023
@kallentu kallentu deleted the 7.0.3 branch November 17, 2023 22:35
@kallentu kallentu mentioned this pull request Dec 1, 2023
1 task
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