From 5b2b2e409b66def53af497f7c6b8048832058999 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Mon, 27 Jan 2025 17:03:16 +0100 Subject: [PATCH 1/5] Document announcements --- docs/publishing.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/docs/publishing.md b/docs/publishing.md index e33d23fa325..86d964bbabb 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -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/123456789) 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/123456789) 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: @@ -69,7 +84,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. From 8abe1018171e00a40912c7b0a9f4b9c1f5a94e54 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Wed, 29 Jan 2025 17:23:41 +0100 Subject: [PATCH 2/5] Add announcements text to the package README --- packages/web-features/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/web-features/README.md b/packages/web-features/README.md index 72876cda114..86c069920fb 100644 --- a/packages/web-features/README.md +++ b/packages/web-features/README.md @@ -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/123456789) announcements thread for news about upcoming releases, such as breaking changes or major features. + ## Usage ```sh From 87873a3b35f36e0f48ff4ca1336a1f049b204474 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Mon, 3 Feb 2025 18:33:41 +0100 Subject: [PATCH 3/5] Add release notes link text --- docs/publishing.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/publishing.md b/docs/publishing.md index 86d964bbabb..134e98e6ce5 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -65,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 our [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/123456789) announcements thread, for advance notice of breaking changes or other significant changes. + ``` + 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. From 5baec1d917432ab940648e6115d87d1b0f485ab4 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Mon, 3 Feb 2025 18:35:27 +0100 Subject: [PATCH 4/5] Make text more consistent --- docs/publishing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/publishing.md b/docs/publishing.md index 134e98e6ce5..32da8d7594d 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -68,7 +68,7 @@ These are the steps to publish a regular release on npm and as a GitHub release: 1. Append this message to the end of the release notes: ```markdown - Subscribe to our [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/123456789) announcements thread, for advance notice of breaking changes or other significant changes. + Subscribe to the [Upcoming changes](https://github.com/web-platform-dx/web-features/discussions/123456789) announcements thread for news about upcoming releases, such as breaking changes or major features. ``` 1. Click **Publish release**. From 81f27ca78305df0c5c4f60c55e331ee49cf3cec6 Mon Sep 17 00:00:00 2001 From: "Daniel D. Beck" Date: Wed, 5 Feb 2025 15:00:42 +0100 Subject: [PATCH 5/5] Replace placeholder links --- docs/publishing.md | 6 +++--- packages/web-features/README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/publishing.md b/docs/publishing.md index 32da8d7594d..d7c8d75a77d 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -4,12 +4,12 @@ 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/123456789) announcements thread or to all discussions through the repository's _Watch_ menu. +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/123456789) announcements thread. +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. @@ -68,7 +68,7 @@ These are the steps to publish a regular release on npm and as a GitHub release: 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/123456789) announcements thread for news about upcoming releases, such as breaking changes or major features. + 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**. diff --git a/packages/web-features/README.md b/packages/web-features/README.md index 86c069920fb..706b6cbfa61 100644 --- a/packages/web-features/README.md +++ b/packages/web-features/README.md @@ -2,7 +2,7 @@ [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/123456789) announcements thread for news about upcoming releases, such as breaking changes or major features. +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