sapcc / juno

Monorepo for the Juno microfrontend framework, microfrontend apps, design system and component library
Apache License 2.0
5 stars 3 forks source link

[github-actions] Use proper comment syntax for `.mdx` files in github action for license and copyright info #590

Open franzheidl opened 2 months ago

franzheidl commented 2 months ago

The new github action to automatically insert SAP copyright and Apache license information into all of our files uses the wrong comment format for .mdx files (html styles <!-- --> comments).

This causes building/running storybook, the environment we use to develop juno-ui-components, to fail.

The proper comments are /* */ or /_ _/ comments. I have fixed these for now manually, but I would expect the new github action to automatically insert the info into any newly created .mdx file, so we need to make sure to use the correct comment syntax in the action.

To check whether storybook runs correctly, you can use npm --w juno-ui-components run storybook.

Screenshot 2024-04-24 at 11 05 36