docs: Release procedure documentation #1649
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spydon
requested review from
wolfenrain,
erickzanardo,
luanpotter and
renancaraujo
st-pasha
reviewed
May 22, 2022
spydon
commented
May 26, 2022
wolfenrain
requested changes
May 27, 2022
CONTRIBUTING.md
Outdated
| - Search through the codebase for `@Deprecated` methods/fields and remove the ones that are marked | ||
| for removal in the version that you are intending to release. | ||
| - Create a PR containing the changes for removing the deprecated entities. | ||
| - Run `melos version -V <package>:<version> -V <package>:<version>` for Melos to generate a |
There was a problem hiding this comment.
Twice the -V? Is it meant to be current vs next? If so we we should make that more explicit in the command
There was a problem hiding this comment.
Twice the -V?
Yes, once for each package, and the version is the version for that package. Would it be more clear if I wrote it like this?
Suggested change
| - Run `melos version -V <package>:<version> -V <package>:<version>` for Melos to generate a | |
| - Run `melos version -V <package1>:<version> -V <package2>:<version>` for Melos to generate a |
Co-authored-by: Jochum van der Ploeg <jochum.vanderploeg@verygood.ventures>
spydon
commented
May 27, 2022
st-pasha
pushed a commit
to st-pasha/flame
that referenced
this pull request
May 29, 2022
Adds documentation about the release procedure and breaking changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Just adds documentation about the release procedure and breaking changes.
Checklist
fix:,feat:,docs:etc).docsand added dartdoc comments with///.examples.Breaking Change