search

pascalgn / npm-publish-action

GitHub action to automatically publish packages to npm
MIT License
221 stars 29 forks source link

Some improvements #11

Closed ghost closed 4 years ago

ghost commented 4 years ago

Document https://github.com/pascalgn/npm-publish-action/blob/8edc0531ab4eac8c0f17b2261818630b6bbec64d/index.js#L15

Update https://github.com/pascalgn/npm-publish-action/blame/master/README.md#L27 to use a version eg: 1.1.0 instead of a commit hash

ghost commented 4 years ago

@pascalgn why did you close this issue without documenting DEFAULT_BRANCH ?

pascalgn commented 4 years ago

I am not quite sure what this issue is about. Is it about preferring a version number over the currently used commit hash or about documenting the DEFAULT_BRANCH option? Or maybe both? 😉

ghost commented 4 years ago

I would say both :) Using versions is the good practice because it uses Git tags Commits are not easy for an user to know if he is up to date.

Also DEFAULT_BRANCH needs to be documented because when I tested it broke on the branch name ;)

pascalgn commented 4 years ago

I tried to think, but cannot remember why I had the DEFAULT_BRANCH option. I don't think it makes sense, so I removed it now! I hope everything is fine now, feel free to reopen or raise a new issue. Thanks for bringing this up! 👍

ghost commented 4 years ago

Thank you ! Ref: https://github.com/pascalgn/npm-publish-action/commit/06e0830ea83eea10ed4a62654eeaedafb8bf50fc