example code is broken

[anoushk1234]

- name: Check semver
  uses: obi1kenobi/cargo-semver-checks-action@v2
- name: Publish to crates.io
  run: # your `cargo publish` code here

GitHub action errors when I use obi1kenobi/cargo-semver-checks-action@v2 also the link on top of the repo re directing to the marketplace is broken giving a 404.

[mgr0dzicki]

Thanks for reporting the issue! We haven't noticed it since we always use the local version of the action...

@obi1kenobi the problem is that I changed ref in all examples from v1 to v2, but we haven't made a new release yet... However, I'm not sure if we want to release v2 now. As you already mentioned some time ago, we still might add some breaking changes to it (I had a little break, but I'm working on baseline caching again). What do you think about a pre-release?

[obi1kenobi]

I agree the current state is not good, but I'm not sure a pre-release will fix it. Ultimately, the issue is that our main branch (which most people see) points to a work-in-progress version and a missing git tag.

The best solution is to quickly get the v2 action into a release-able state. Is that feasible? Do you think you'll have the time to devote to this in the next few days, or is it not a good time?

Otherwise, we may need to revert the changes. They are too confusing right now, and at least two separate users have run into this problem thus far...

[mgr0dzicki]

I'm currently working on the baseline caching, I'll open the PR today and ask for your review. Since there is a new release of cargo-semver-checks, I can also remove the temporary fix for Windows machines. Is there anything more that has to be done before releasing v2?

[obi1kenobi]

It'll be a solid start! We'll probably want to add tweaks to it over time to improve caching and implement other best practices, but I think it'll be a good point to release it.

[obi1kenobi]

Make sure to check out #27 and #28 as things we should include in the v2 release.

[mgr0dzicki]

@anoushk1234 it took some time, but the new version of the action is finally released and it uses new cargo-semver-checks v0.20.0, which includes massive running-time improvements. You can now use the action as described in the README. I hope it will be useful!