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

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

Closed
franzheidl opened this issue Apr 24, 2024 · 1 comment
Assignees

Comments

@franzheidl
Copy link
Contributor

franzheidl commented Apr 24, 2024

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
franzheidl added a commit that referenced this issue Apr 24, 2024
The newly introduced github-action to automatically insert copyright and license information into each file in our project currently uses the wrong comment syntax for .mdx files, causing the storybook build to fail.

Created #590 to address fixing this permanently.
andypf pushed a commit that referenced this issue Apr 26, 2024
The newly introduced github-action to automatically insert copyright and license information into each file in our project currently uses the wrong comment syntax for .mdx files, causing the storybook build to fail.

Created #590 to address fixing this permanently.
andypf pushed a commit that referenced this issue Apr 26, 2024
The newly introduced github-action to automatically insert copyright and license information into each file in our project currently uses the wrong comment syntax for .mdx files, causing the storybook build to fail.

Created #590 to address fixing this permanently.
@andypf
Copy link
Collaborator

andypf commented Aug 16, 2024

We removed the workflow that automatically added the license header. Instead, we implemented a checker to ensure the license header is present, requiring the developer to add it manually.

@andypf andypf closed this as completed Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants