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

Publishing prereleases – Suggest -wip for naming convention during development #2453

Open
kevmoo opened this issue May 27, 2020 · 11 comments
Labels
dev.packages Relates to package publishing e1-hours Can complete in < 8 hours of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged

Comments

@kevmoo
Copy link
Member

kevmoo commented May 27, 2020

Page URL: https://dart.dev/tools/pub/publishing#publishing-prereleases
Page source: https://github.com/dart-lang/site-www/tree/master/src/tools/pub/publishing.md

We tend to use -dev as a suffix for packages during development – only changing it before we publish. This makes it easy for someone looking at the source to understand the state of the package. See https://github.com/dart-lang/sdk/wiki/External-Package-Maintenance

First, should be generalize this convention?

If yes, we should update this page. Use -alpha or -beta

If yes, we may also want to go as far as adding a warning (or error) to the pub client.

CC @mit-mit @jakemac53 @natebosch @kwalrath

@mit-mit
Copy link
Member

mit-mit commented May 29, 2020

I'm confused, because we have an internal team practice on a few packages, we now want to change our external guidance for how our customers should do it?

I like the current guidance; using -dev is aligned with the version numbers we use for the core SDK: https://dart.dev/get-dart#release-channels

Wouldn't it be simpler to change our internal practice to use something like -unpublished?

@jakemac53
Copy link
Contributor

I don't think we need to be overly prescriptive here, I would definitely not add a warning or error to pub.

Given that we are going to start publishing pre-release versions then I agree with @mit-mit that we should reconsider how we are managing the "in progress" versions as the current -dev strategy would become confusing I think.

@kevmoo
Copy link
Member Author

kevmoo commented May 29, 2020

I'm fine going either way – just pushing for consistency here.

A lot of folks follow along w/ our repos and assume we're always using best practices.

@kevmoo kevmoo closed this as completed May 29, 2020
@kevmoo
Copy link
Member Author

kevmoo commented May 29, 2020

Didn't mean to close!

@kevmoo kevmoo reopened this May 29, 2020
@kwalrath kwalrath added the act.wait-for-customer Needs response from customer label Jul 17, 2020
@atsansone
Copy link
Contributor

@mit-mit , @kevmoo , @jakemac53 : Is this still a going concern? If so, do you have any updates?

@natebosch
Copy link
Member

I agree with @mit-mit that we should reconsider how we are managing the "in progress" versions as the current -dev strategy would become confusing I think.

WDYT about -wip to replace our current non-publishing usage of -dev?

@mit-mit
Copy link
Member

mit-mit commented Apr 11, 2023

-wip sgmt. one other idea is -next

@kevmoo
Copy link
Member Author

kevmoo commented Apr 11, 2023

CC @devoncarew – would be good to get this into our tooling if this is our new protocol.

@kevmoo
Copy link
Member Author

kevmoo commented Apr 11, 2023

I like -wip

@atsansone atsansone changed the title 'Publishing packages' – Publishing prereleases – should we demonstrate w/ -dev? 'Publishing packages' – Publishing prereleases – should we set a naming convention? Apr 11, 2023
@atsansone atsansone added e1-hours Can complete in < 8 hours of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged dev.packages Relates to package publishing and removed act.wait-for-customer Needs response from customer labels Apr 11, 2023
@jakemac53
Copy link
Contributor

No opinion here, happy to use whatever suffix.

@parlough parlough changed the title 'Publishing packages' – Publishing prereleases – should we set a naming convention? Publishing prereleases – Suggest -wip for naming convention during development Dec 18, 2023
@parlough
Copy link
Member

parlough commented Dec 18, 2023

Sounds like there has been consensus on using -wip as a bunch of Dart team projects have migrated to doing so.

Unless someone chimes in, the task here is now:

  • Update docs to suggest -wip as suffix for in-progress work and -dev for prereleases

Thanks all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev.packages Relates to package publishing e1-hours Can complete in < 8 hours of normal, not dedicated, work p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged
Projects
None yet
Development

No branches or pull requests

7 participants