search

Kir-Antipov / mc-publish

🚀 Your one-stop GitHub Action for seamless Minecraft project publication across various platforms.
MIT License
225 stars 18 forks source link

Add debugging features #45

Open Minecraftschurli opened 1 year ago

Minecraftschurli commented 1 year ago

A dry run option that prints the parsed data and not actually uploads the files would be nice to test this out without uploading stuff

Kir-Antipov commented 1 year ago

Please, help me understand, why does the project need this feature in the first place? At this moment in time I'm pretty sceptical about adding new functionality to mc-publish, especially when it involves some ugly global flags that mutates the whole action's workflow.

Maybe a problem you have with the action can be solved by more accessible and verbose documentation? Alternatively, maybe you find some of the inputs counterintuitive, which once again can be solved by better documentation or by altering inputs' logic? Let me know

Prospector commented 1 year ago

It's fairly common for an author to want to check that their build system is fully working before hooking it up to a production project on Modrinth.

Kir-Antipov commented 1 year ago

While I understand the purpose I don't really want to enforce "tweak it until it works" behavior amongst users. So there won't be a new input to enable debug mode as suggested by Minecraftschurli, nor there will be an option to use Modrinth's staging server as you suggested (since this is a partial solution for only one platform, when there are 3 of them and probably there will be more in v4.0).

But GitHub has some sort of convention for GitHub Actions debugging, which can be implemented for this action too. Therefore, when you really-really need to debug your workflow, you'll be able to do so and get more verbose logs and dummy publishing to different platforms, but the whole run should be subjected for debugging in such cases, which makes perfect sense if you ask me.