Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 24 additions & 3 deletions docs/publishing.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
# Publishing
# Publishing releases

## Announcements

web-features uses a GitHub Discussions thread to give notice of breaking changes and other major changes to interested web-features consumers.

If you want to receive these announcements, subscribe to the [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/2613) announcements thread or to all discussions through the repository's _Watch_ menu.

> [!NOTE]
> The remainder of this section is for [project owners](../GOVERNANCE.md#roles-and-responsibilities).

If you're planning to publish a breaking release (see [Regular releases](#regular-releases)) in the next two weeks, then post a message to the [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/2613) announcements thread.
Include a summary of the expected changes, citing relevant issues and pull requests.

Note that an announcement is not a substitute for seeking consumer feedback early in the design and implementation process.
Announcements should not provoke surprising responses from consumers.

## Regular releases

> [!NOTE]
> This information is for [project owners](../GOVERNANCE.md#roles-and-responsibilities).
> This section 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:

Expand Down Expand Up @@ -50,6 +65,12 @@ These are the steps to publish a regular release on npm and as a GitHub release:
```

1. Remove all lines from Dependabot.
1. Append this message to the end of the release notes:

```markdown
Subscribe to the [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/2613) announcements thread for news about upcoming releases, such as breaking changes or major features.
```

1. Click **Publish 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.
Expand All @@ -69,7 +90,7 @@ You can install these prereleases using a command such as `npm install web-featu
## Secrets

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

Publishing requires the `NPM_TOKEN` repository secret.

Expand Down
4 changes: 4 additions & 0 deletions packages/web-features/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Curated list of Web platform features

[web-features](https://web-platform-dx.github.io/web-features/web-features/) is the package that describes Web platform features and provides [Baseline](https://web-platform-dx.github.io/web-features/) status reports.

Subscribe to the [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/2613) announcements thread for news about upcoming releases, such as breaking changes or major features.

## Usage

```sh
Expand Down