AlbertHernandez / github-action-nodejs-template

Template for new Github Actions based on Typescript with the Best Practices and Ready to be Released
github.com/AlbertHernandez/github-action-nodejs-template
MIT License
10 stars 1 forks source link

ci: Added auto updating of inputs, outputs, etc in README #259

Open actuarysailor opened 1 week ago

actuarysailor commented 1 week ago

Proposed changes

@AlbertHernandez - added a common github action I use for many of the actions I have developed or been involved with that automatically updates the readme file with:

This implements and closes #252

Checklist

Further comments

Doesn't really impact underlying code at all, just auto updates some items in readme.

AlbertHernandez commented 6 days ago

Hi @actuarysailor, thanks for the PR, I have been testing the proposed changes here and it seems we need to adjust a bit the code:

  1. It seems the action does not allow us to not include the headers like ## description, ## input. I would like to have control over this because if not, for example, in the description it breaks the format and does not look good. Also for input and output titles, I usually add emojis to these headers, so if we use this action we will have a different format.
  2. In the usage, when is generated automatically is not a good usage example, we are missing things like the checkout, just speficy major version and not entire one... and this can provide a bad experience for the clients

Knowing this, I would just include the changes related to generation of inputs and outputs, but keep as it is the part of the description and the usage and the others. Also, I am going to create a feature-request in the other action to improve it a bit and be able to omit headers using some property or something that we can use to have the control there, and once we have that, we can use this for other things.

I have created a PR with final state here, when you have time, change your PR with that code and I will merge your changes (so it will appear you have contributed here)