search

obi1kenobi / cargo-semver-checks-action

A GitHub Action for running cargo-semver-checks
MIT License
60 stars 15 forks source link

Add full example for beginers #59

Closed c-git closed 11 months ago

c-git commented 11 months ago

Warning included for using for also publishing as it runs on both pull requests and pushes. Wasn't sure what was the best way to express that they need to not just use it verbatim if they are also going to be publishing using the same workflow

c-git commented 11 months ago

Added where to put the file for beginners

obi1kenobi commented 11 months ago

This is definitely nice for beginners, but I think it makes it worse for people who are already comfortable with GitHub Actions because it's more verbose. GitHub Actions usually tend to start by showing the smallest code to run them, then expand into an end-to-end example. For example, consider: https://github.com/actions/setup-python

It's also a bit dangerous because it presents an example workflow that is configured to break on breaking changes, and then runs it on every PR. Many people's workloads are not aligned with this approach, and the example will break for them and be quite frustrating.

I think the basic idea here is sound, and just requires another half hour or hour of polishing work:

c-git commented 11 months ago

Ok makes sense, I only push to main when I'm going to release hence that's why it works for me. I haven't found a simple workflow that does cargo publish yet that I can use as an example. I will have to look into triggering on version number tags as well. I also agree about putting it in a new section (I was on the fence about the placement). However, it don't think it's just an hour of work left because of the amount I need to go search for and test. I propose to close this PR for now and reopen once I understand github actions a bit more and have a good example to pattern on. Let me know what you think.

obi1kenobi commented 11 months ago

Sounds good to me 👍

On Fri, Nov 10, 2023, 3:05 AM One @.***> wrote:

Ok makes sense, I only push to main when I'm going to release hence that's why it works for me. I haven't found a simple workflow that does cargo publish yet that I can use as an example. I will have to look into triggering on version number tags as well. I also agree about putting it in a new section (I was on the fence about the placement). However, it don't think it's just an hour of work left because of the amount I need to go search for and test. I propose to close this PR for now and reopen once I understand github actions a bit more and have a good example to pattern on. Let me know what you think.

— Reply to this email directly, view it on GitHub https://github.com/obi1kenobi/cargo-semver-checks-action/pull/59#issuecomment-1805266912, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAR5MSV6BA2Z6MJC4ZMOHG3YDXN5ZAVCNFSM6AAAAAA7FI6EGGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMBVGI3DMOJRGI . You are receiving this because you commented.Message ID: @.***>

c-git commented 11 months ago

Ok cool will reopen after I get a better understanding of publishing crates from actions