Add test case for mlc doc script detect-os

[shahfarazz]

This PR adds a basic test case for the mlc doc script command targeting the detect-os script. It checks if the README.md is correctly generated.

📌 Notes
The test checks for successful execution and file presence.

Verified locally using pytest.

Let me know if you'd like help improving or customizing this further!

[github-actions]

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

[shahfarazz]

I’ve signed and submitted the CLA, just waiting for approval. Let me know if anything else is needed from my side!

[anandhu-eng]

Hey @shahfarazz , thanks for dropping a PR.

Just wanted to ask how are we running the test. We usually have GitHub action workflow files for these tests, one such examples would be found here.

@arjunsuresh should we add the test for mlc doc script in mlcflowor mlperf-automations

Edit: I see that these tests would be useful if we include it in both mlcflow(in test-mlc-core-actions.yaml) and mlperf-automations(call the mlc-core-action workflow)

[shahfarazz]

Thanks, @anandhu-eng! At the moment, I’ve just run the test locally with pytest to validate functionality. Once the CLA is cleared and I get confirmation on where to place the workflow (either here or in mlcflow), I’ll proceed to set up the GitHub Action accordingly.

Appreciate the feedback!

[arjunsuresh]

@anandhu-eng yes, we can place the github action in both the repos. May be in the doc action, we can return a key readme_path which makes it easier to do tests.

[shahfarazz]

recheck

[shahfarazz]

Hi, I received email confirmation this morning at 5:37 AM Central Time from Liz Walker that my CLA submission was approved. It still hasn’t updated on GitHub, so I’m waiting for that to reflect. Let me know if there’s anything else needed from my end!

Thanks,
Faraz

[arjunsuresh]

Hi @shahfarazz thanks for your PR. The CLA approval shouldn't have taken more than a couple of days. It seems your github user is still not approved.

But adding a test for doc action for detect-os inside the detect-os script is not the proper way. Because that would imply adding a test for every action for every scripts which is not scalable. Instead if we add a github action for doc action which will automatically initiate for any change in the script meta, that'll be better. Actually the below action is doing that but it is missing the check for timestamp check which you have added in your PR. Do you think it is possible to apply it to the below GH action?

https://github.com/mlcommons/mlperf-automations/blob/main/.github/workflows/document-scripts.yml