Skip to content

Document how to make a web-features release #1560

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Aug 8, 2024
Merged

Document how to make a web-features release #1560

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c5b791
Document how to make a web-features release
foolip Aug 8, 2024
b28800e
Update docs/publishing.md
foolip Aug 8, 2024
fedebf5
Apply suggestions from code review
foolip Aug 8, 2024
79f93f3
Update publishing.md
foolip Aug 8, 2024
e71cb04
Update publishing.md
foolip Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion docs/publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,28 @@
# Publishing

## Regular releases

> [!NOTE]
> This information is for [project owners](../GOVERNANCE.md#roles-and-responsibilities).

These are the steps to publish a regular release on NPM and as a GitHub release:

- 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.
- Update `packages/web-features/package.json` and `packages/web-features/package-lock.json` in a PR and get review.
- Merge the PR and draft a new release at https://github.com/web-platform-dx/web-features/releases/new
- Fill in the tag name `vX.Y.Z` manually as both the tag and release title
- For major releases, add a "Breaking Changes" section up top.
- For minor releases, add a "What's New" section up top.
- Click "Generate release notes"
- Search for "<" and make sure all element names are quoted with backquotes
- Remove all lines from Dependabot
- Publish the GitHub release

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.

## `@next` releases

The [`publish_next_` GitHub Actions workflows](https://github.com/web-platform-dx/web-features/tree/main/.github/workflows) automatically publish pre-releases on push to the main branch using the `next` [npm dist tag](https://docs.npmjs.com/adding-dist-tags-to-packages).
The [Publish web-features@next GitHub Actions workflows](https://github.com/web-platform-dx/web-features/blob/main/.github/workflows/publish_next_web-features.yml) automatically publish pre-releases on push to the main branch using the `next` [npm dist tag](https://docs.npmjs.com/adding-dist-tags-to-packages).
You can install these prereleases using a command such as `npm install web-features@next`.

## Secrets
Expand Down