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

add CI job, which verifies that the README.md contains the generated compiler support table #2439

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

SimeonEhrig
Copy link
Member

The script generate_supported_compilers.py generates the compiler support Markdown table for the README.md from a config file. The script was introduced because the markdown table is huge and hard to modify.

Therefore the CI job checks if the README.md contains the markdown table, which is generated from the script. This covers the case, if somebody is changing directly the README.md instead modifying the supported_compilers.json, rendering a new table and copy the output in the README.md.

@SimeonEhrig
Copy link
Member Author

@AuroraPerego Can you please check, if the error message is helpful: https://github.com/alpaka-group/alpaka/actions/runs/12274502625/job/34247545316?pr=2439

@SimeonEhrig SimeonEhrig force-pushed the ciAddCompilerSupportTableCheck branch from 6cb2ecb to abe48e4 Compare December 11, 2024 10:38
@AuroraPerego
Copy link
Contributor

@AuroraPerego Can you please check, if the error message is helpful: https://github.com/alpaka-group/alpaka/actions/runs/12274502625/job/34247545316?pr=2439

yes, it does not tell directly which number in that line is the wrong one but the instructions on how to fix it are clear, I think it's fine, thanks!

@SimeonEhrig
Copy link
Member Author

@AuroraPerego Can you please check, if the error message is helpful: https://github.com/alpaka-group/alpaka/actions/runs/12274502625/job/34247545316?pr=2439

yes, it does not tell directly which number in that line is the wrong one but the instructions on how to fix it are clear, I think it's fine, thanks!

Thant's good :-)
I can only display, which line number in the generated table was not found in the README.md. The problem is, I have no anchor point in README.md. Therefore I need to find the table. If line 0 of the table in the README.md does not match the line 0 of the generated table, I can only assume where the is table starting.
In the end you have the same problem like in git. Sometimes your diffs looks pretty strange because git can also only assume what you actual changed.

But nevertheless, in the end you will replace the whole table and normally you know what you changed in the README.md. Therefore the line number should be not necessary.

@SimeonEhrig SimeonEhrig force-pushed the ciAddCompilerSupportTableCheck branch from abe48e4 to 12530c9 Compare December 12, 2024 12:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants