search

nizarmah / auto-minify

Minifies JS and CSS files in GitHub workflows.
GNU General Public License v3.0
48 stars 18 forks source link

Update action version number in README.md #23

Closed ronan-smith closed 2 years ago

ronan-smith commented 2 years ago

On attempting to use this action it failed with the error Unable to resolve action nizarmah/auto-minify@v2, unable to find version v2 - after checking the repository it looks like the examples have not been updated to match the release number.

ronan-smith commented 2 years ago

Hi @nizarmah - After you implemented #15 I tried to run the action in my personal workflow and it failed even though I was following your documentation.

I realised what I needed to do in order to make the action work again, I have updated the examples in the README.md to reflect this.

Please let me know if this isn't suitable! 😄

nizarmah commented 2 years ago

Hello @ronan-smith! Thanks for opening this pull request!

To be honest, I'm not really sure yet how to deal with Semantic Versioning and Documentations.

So I was planning to look into things more closely over the weekend to have a better idea if this change is needed, or if I should do a small trick with the tagging.

I'll let you know. I'll either have this merged by Monday, or I'll solve the issue in another way 👍🏼

I'll keep you updated over this pull request 😃

ronan-smith commented 2 years ago

Thanks for taking the time to respond @nizarmah 😃 Please keep me informed, at the moment if people use the examples in the README then their action will fail, it either needs to be v2.0 or v2.1 (Correct me if I am wrong, I'm just guessing) - not sure if you can edit releases once pushed but if you change the versioning system again then the workflows using the action will error as mine did.

nizarmah commented 2 years ago

@ronan-smith you're right. The current version is problematic. Accordingly, I'm thinking of merging the changes, and then looking into the semantic versioning over the weekend and making the necessary changes. 👍🏼

Thanks again for your contribution 🤗

Spreeuw commented 2 years ago

@nizarmah Here's what the manual says about versioning, you're already following semantic versioning so I think all that was missing is step 3?

  1. Make the new release available to those binding to the major version tag: Move the major version tag (v1, v2, etc.) to point to the ref of the current release. This will act as the stable release for that major version. You should keep this tag updated to the most recent stable minor/patch release.
git tag -fa v1 -m "Update v1 tag"
git push origin v1 --force

So rather than changing the readme for each release, if you stick to SemVer you can leave @v2 in the examples, and all you need to do is update the main v2 tag after each release. I you could automate this pretty easily I think ;)

yep, just 2 random examples:

https://github.com/marketplace/actions/actions-tagger https://github.com/marketplace/actions/update-semver