Don't strip out @alpha items from generated reports
#4329
Conversation
It is useful for `@alpha` items to appear in metadata and generated documentation. The system currently unconditionally strips all `@alpha` items out. I don't know how important it is to preserve existing behavior. If so, perhaps this should be configurable somehow? Any feedback / suggestions would be appreciated.
Josmithr
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L and
dmichon-msft
as code owners
Josmithr
changed the title
@alpha items from report@alpha items from generated reports
|
You'll want to do a search for |
Can do. Thanks! |
@dmichon-msft I believe I handled all of the relevant paths. I left one question about default content presentation for api-documenter, but otherwise it's hopefully ready for review. |
| "changes": [ | ||
| { | ||
| "packageName": "@microsoft/api-extractor", | ||
| "comment": "Don't strip out @alpha items when generating API reports.", |
There was a problem hiding this comment.
@dmichon-msft for future reference, this should have been a MINOR version bump. It is a significant behavioral change that may cause previously undisclosed content to appear on a public website.
There was a problem hiding this comment.
Gah, I've gotten so used to the Rush projects where the version bump isn't part of the PR that I forgot to check that.
There was a problem hiding this comment.
What is the process for correcting this? I'm happy to put up a PR fixing this if I can get guidance.
Don't strip out `@alpha` items from generated reports
It is useful for
@alphaitems to appear in metadata and generated documentation. The system currently unconditionally strips all@alphaitems out.I don't know how important it is to preserve existing behavior. If it is, perhaps this should be configurable somehow? Any feedback / suggestions would be appreciated.
I posted a question in the chatroom about this but have not yet heard back. I'll link to this PR from there as well.