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

Incorrect template #167

Closed
blackfalcon opened this issue Mar 12, 2024 · 0 comments · Fixed by #169
Closed

Incorrect template #167

blackfalcon opened this issue Mar 12, 2024 · 0 comments · Fixed by #169
Assignees
Labels
auro-combobox not-reviewed Issue has not been reviewed by Auro team members Type: Bug Bug or Bug fixes

Comments

@blackfalcon
Copy link
Member

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.

const readmeTemplateUrl = 'https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README_esm.md';

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:

https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md

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 #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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auro-combobox not-reviewed Issue has not been reviewed by Auro team members Type: Bug Bug or Bug fixes
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants