Skip to content

Commit 3af374d

Browse files
authored
Publishing docs: apply miscellaneous edits (#1650)
* Number the steps * Use full stops consistently * Add regex hint for creating releases * Add follow up step for "version required" labels * Provide Markdown literals for pasting into the release description * Explain where we're checking for unescaped HTML
1 parent a91dff1 commit 3af374d

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

docs/publishing.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,27 @@
77
88
These are the steps to publish a regular release on NPM and as a GitHub release:
99

10-
- Determine if it should be a major, minor, or patch release. The "[major version required](https://github.com/web-platform-dx/web-features/pulls?q=is%3Apr+is%3Amerged+label%3A%22major+version+required%22+sort%3Aupdated-desc)" and "[minor version required](https://github.com/web-platform-dx/web-features/pulls?q=is%3Apr+is%3Amerged+label%3A%22minor+version+required%22+sort%3Aupdated-desc)" labels should be used to support this decision.
11-
- Update `packages/web-features/package.json` and `packages/web-features/package-lock.json` in a PR and get review.
12-
- Merge the PR and draft a new release at https://github.com/web-platform-dx/web-features/releases/new
13-
- Fill in the tag name `vX.Y.Z` manually as both the tag and release title
14-
- For major releases, add a "Breaking Changes" section up top.
15-
- For minor releases, add a "What's New" section up top.
16-
- Click "Generate release notes"
17-
- Search for "<" and make sure all element names are quoted with backquotes
18-
- Remove all lines from Dependabot
19-
- Publish the GitHub release
10+
1. Determine if it should be a major, minor, or patch release. The "[major version required][major-version]" and "[minor version required][minor-version]" labels should be used to support this decision.
11+
1. Update `packages/web-features/package.json` and `packages/web-features/package-lock.json` in a PR and get review.
12+
1. Merge the PR and draft a new release at https://github.com/web-platform-dx/web-features/releases/new.
13+
1. Fill in the tag name `vX.Y.Z` manually as both the tag and release title.
14+
1. For major releases, add a `## Breaking Changes` section up top.
15+
1. For minor releases, add a `## What's New` section up top.
16+
1. Click **Generate release notes**.
17+
1. In the release description, find unescaped `<` characters and make sure that HTML elements are enclosed with backticks.
18+
19+
This regular expression can help:
20+
21+
```regex
22+
/ (?<!`)<(.*?)> /
23+
```
24+
25+
1. Remove all lines from Dependabot.
26+
1. Publish the GitHub release.
27+
1. Remove the "[major version required][major-version]" and "[minor version required][minor-version]" labels from any pull requests that were included in the release.
28+
29+
[major-version]: https://github.com/web-platform-dx/web-features/pulls?q=is%3Apr+is%3Amerged+label%3A%22major+version+required%22+sort%3Aupdated-desc
30+
[minor-version]: https://github.com/web-platform-dx/web-features/pulls?q=is%3Apr+is%3Amerged+label%3A%22minor+version+required%22+sort%3Aupdated-desc
2031

2132
Publishing the GitHub release creates the tag. This triggers the [Publish web-features GitHub Actions workflows](https://github.com/web-platform-dx/web-features/blob/main/.github/workflows/publish_web-features.yml), uploads GitHub release artifacts and publishes the package to NPM.
2233

0 commit comments

Comments
 (0)