While this is a DOCS update, a release is needed in order to update the Auro Docsite. It is preferred that this is listed as a docs commit and this issue is in the same PR with issue https://github.com/AlaskaAirlines/auro-combobox/issues/166 which will be a PATCH release.
A local build is not needed for this PR. The postversion script will fire with a release and rebuild the docs in the remote and commit back to the repo with the CHANGELOG and PACKAGE.json updates.
Exit criteria
This issue can be closed once the template reference has been corrected and the rendered README file does not display the ESM badge.
Please verify the version of auro-combobox you have installed
@latest
Please describe the bug
This line of code is incorrectly referencing the wrong README template.
https://github.com/AlaskaAirlines/auro-combobox/blob/fb4ab6f4aa1786578032ef8166eef2e4031530ad/scripts/generateDocs.mjs#L8
This reference allows the ESM badge to appear on a component that is not ESM/SSR compatible.
Reproducing the error
None
Expected behavior
The ESM/SSR badge should only appear on elements that are compatible with this spec. Update to the following:
What browsers are you seeing the problem on?
No response
Additional context
While this is a DOCS update, a release is needed in order to update the Auro Docsite. It is preferred that this is listed as a
docs
commit and this issue is in the same PR with issue https://github.com/AlaskaAirlines/auro-combobox/issues/166 which will be aPATCH
release.A local build is not needed for this PR. The
postversion
script will fire with a release and rebuild the docs in the remote and commit back to the repo with the CHANGELOG and PACKAGE.json updates.Exit criteria
This issue can be closed once the template reference has been corrected and the rendered README file does not display the ESM badge.