Publishing docs: update steps for new release workflow #2196
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
This documents the new workflow added in web-platform-dx#2191
github-actions
bot
added
the
documentation
ddbeck
commented
Nov 8, 2024
Comment on lines
+41
to
+52
| 1. For minor releases, add a `## What's New` section to the top of the release notes, before all other sections. | ||
| 1. For major releases, add a `## Breaking Changes` section to the top of the release notes, before all other sections. | ||
| 1. Click **Generate release notes**. | ||
| 1. In the release description, find unescaped `<` characters and make sure that HTML elements are enclosed with backticks. | ||
|
|
||
| This regular expression can help: | ||
|
|
||
| ```regex | ||
| / (?<!`)<(.*?)> / | ||
| ``` | ||
|
|
||
| 1. Remove all lines from Dependabot. |
There was a problem hiding this comment.
I'm going to target these steps for automation next. 😈
szepeviktor
reviewed
Nov 8, 2024
|
|
||
| 1. Review the PR. | ||
|
|
||
| 1. Close and reopen the relase PR, to allow the tests to run. |
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.
This documents the new workflow added in #2191.
I don't need anyone to actually test this (I'll follow it on the next web-features release), but it'd be nice to have someone read through it.