Skip to content
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.

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

Use GitHub Discussions for periodic announcements #2589

Merged
merged 5 commits into from
Feb 5, 2025

Conversation

ddbeck
Copy link
Collaborator

@ddbeck ddbeck commented Jan 28, 2025

A couple of weeks ago, it came up on the WebDX call that we should have a dedicated announcements channel for web-features consumers. This is my proposal for doing that.

This PR adds documentation describing a process for publishing project announcements to GitHub Discussions.

If we choose to merge this PR, then we'll need to do the following just before merging:

  • Turn on Discussions in the repository settings.
  • Create a thread to post announcements to that is open to subscribing for notifications, but not open generally to replies (i.e., is locked)
  • Turn off all other discussions (we don't really have a use for non-announcements yet).
  • Update the documentation to link to the thread.

After merging, we should:

  • Link to discussion thread and this PR's documentation in the next release's release notes.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 28, 2025
Comment on lines 5 to 7
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) <!-- TODO: link to the actual discussion thread, after it's created --> announcements thread or to all discussions through the repository's _Watch_ menu.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to add this (or some version of it) to the repo's root-level README.md file too. Something along the lines of "To use web-features, do this ... you can also see releases here ... and follow this GH discussion for breaking and major changes announcements ...".

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this to the package README with 8abe101. Since the repo README already links there, do you think that's sufficient?

@ddbeck
Copy link
Collaborator Author

ddbeck commented Jan 30, 2025

This came up on the WebDX call today. One suggestion was to add a link to the announcements thread to our release notes boilerplate text. I'll update the Markdown file about this after the call.

@ddbeck
Copy link
Collaborator Author

ddbeck commented Feb 3, 2025

OK, I this is ready now. If I get an approving review, I'll do the task list at the top, update the links, and merge this.

@ddbeck ddbeck enabled auto-merge (squash) February 5, 2025 14:01
@ddbeck ddbeck merged commit be57ac5 into web-platform-dx:main Feb 5, 2025
3 checks passed
@ddbeck ddbeck deleted the announcements-channel branch February 5, 2025 14:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants