-
Notifications
You must be signed in to change notification settings - Fork 87
Add hotfix instructions to DWDS #1876
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Elliott, I left some comments
dwds/CONTRIBUTING.md
Outdated
[commit history view](https://github.com/dart-lang/webdev/commits/master), | ||
find the commit that prepared the release of DWDS that you would like to | ||
hotfix. | ||
1. Click on `< >` ("Browse the repository at this point in history"). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2? :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a side affect of running the autoformatter - it still gets rendered as a numeric sequence (1, 2, 3, etc)
dwds/CONTRIBUTING.md
Outdated
`git branch -a | grep 16.0.2-hotfix-release` | ||
1. Track that branch with `git checkout --track branch_name` (e.g. | ||
`remotes/upstream/16.0.2-hotfix-release`) | ||
1. You can now make the change you would like to hotfix on the branch you have. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add instructions on how to modify the CI for the hotfix branch before adding the actual fix (remove testing on irrelevant sdk versions, add testing on relevant sdk versions if needed, remove sending notifications, etc)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
dwds/CONTRIBUTING.md
Outdated
[commit history view](https://github.com/dart-lang/webdev/commits/master), | ||
find the commit that prepared the release of DWDS that you would like to | ||
hotfix. | ||
1. Click on `< >` ("Browse the repository at this point in history"). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add general description of the steps, so it is clear what are we trying to do? The steps above could move under the general step as sub-steps (so the user can chose to do them differently if needed, for example, via git commands)
For example
- create a branch off the release that needs a hotfix
a. In the Github UI's
commit history view,
find the commit that prepared the release of DWDS that you would like to
hotfix.
b. Click on< >
("Browse the repository at this point in history").
... - Update CI for the new branch
a ... - Add the fix
a. - publish
a.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done!
`git checkout --track branch_name` (e.g. | ||
`remotes/upstream/16.0.2-hotfix-release`) | ||
|
||
1. Update the CI tests so that the branch tests against the appropriate Dart |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with small change request - the sequential numbering is still showing all 1's, can we update it to 1, 2, 3...?
This is a change made by the Markdown auto-formatter. You can create a sequentially ordered list using all 1s. That way MD automatically handles the numbering. |
Follow-up to #1867