Skip to content

Add Baseline regression notes #3187

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

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ddbeck
Copy link
Collaborator

@ddbeck ddbeck commented Jul 28, 2025

This is a work in progress toward fixing #1971.

This structures the existing Baseline regression comments as notes. I'm looking for early feedback on whether this structure for notes would be useful.

@github-actions github-actions bot added the feature definition Creating or defining new features or groups of features. label Jul 28, 2025
Comment on lines -5 to -10
# TODO: https://github.com/web-platform-dx/web-features/issues/1971
# Status changed: https://github.com/web-platform-dx/web-features/pull/2358, https://github.com/web-platform-dx/web-features/pull/2491
# 2024-12-19 — low → false — Regressed status to match Caniuse, which considers support beginning at BYOB shipping.
# 2025-01-30 — false → high — Split BYOB into a separate "readable-byte-streams" feature. Linked that one to Caniuse.
# References:
# - https://caniuse.com/streams
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 fussed over this for a while and ended up deciding to omit the note entirely. The first note would say that the feature regressed, the second note would be some new category (advance? unregression?) showing that we more or less reverted the second note. It seemed to me that the correct course of action in that scenario would be to withdraw the note, so that's what I've done.

@ddbeck ddbeck added package:web-features schema Schema changes, proposals, and bugs minor version required This PR requires a minor version semver release (vX.Y+1.0) labels Jul 28, 2025
- category: baseline-regression
date: 2025-01-30
message: >
The `content-visibility` feature regressed from newly available to limited availability.
Copy link
Contributor

Choose a reason for hiding this comment

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

For any kind of extraordinary status change, it might also be useful to the tools consuming this info to encode it into the note:

old_status: low
new_status: false

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good suggestion. I've made changes along these lines with fccb850. It also meant that I could drop boilerplate text from each message.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature definition Creating or defining new features or groups of features. minor version required This PR requires a minor version semver release (vX.Y+1.0) package:web-features schema Schema changes, proposals, and bugs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants