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

refactor the readme #72

Merged
merged 1 commit into from Feb 15, 2023
Merged

refactor the readme #72

merged 1 commit into from Feb 15, 2023

Conversation

devoncarew
Copy link
Member

General refactoring of the readme:

  • move the version history back into the changelog file (but keep a pointer to it from the readme); fix move changelog info back into a separate file #70
  • bump the hello world example to the top of the file
  • some clarifications around raw and release flavors

@athomas, wrt the raw and release flavors. Isn't this something we can determine w/o an input arg? stable, beta, and dev channels would imply a release flavor, and the main channel would imply a raw flavor?

@athomas
Copy link
Member

athomas commented Feb 15, 2023

@athomas, wrt the raw and release flavors. Isn't this something we can determine w/o an input arg? stable, beta, and dev channels would imply a release flavor, and the main channel would imply a raw flavor?

main implies raw SGTM.

There is a difference. Using dev+raw gives you all dev builds (created automatically every ~4 hours). published only gives you those that we manually published, typically twice a week. For beta, there's not much of a difference because we usually publish the beta shortly after the build. For stable, we are supposed to have roughly 1 week between the build and publish. Flavor is an advanced features that most people won't need. It may be useful for some dart-lang repos (that's why it was added).

@devoncarew
Copy link
Member Author

There is a difference. Using dev+raw gives you all dev builds (created automatically every ~4 hours). published only gives you those that we manually published, typically twice a week. For beta, there's not much of a difference because we usually publish the beta shortly after the build. For stable, we are supposed to have roughly 1 week between the build and publish. Flavor is an advanced features that most people won't need. It may be useful for some dart-lang repos (that's why it was added).

Gotcha, thanks for the explanation!

@devoncarew devoncarew merged commit 594ae13 into main Feb 15, 2023
@devoncarew devoncarew deleted the readme_changelog branch March 1, 2023 07:22
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.

move changelog info back into a separate file
2 participants