microsoft / beachball

The Sunniest Semantic Version Bumper

Home Page:https://microsoft.github.io/beachball

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docs for check command should include tips for GitHub Actions

jattasNI opened this issue · comments

When my repo added the beachball check command to a GitHub Action which runs on PRs, it didn't detect changes correctly. The issue turned out to be the same as the one described in #420.

It would have been helpful if the fix from that issue were described in the documentation for the check command.

My proposal would be to include something like this in a new GitHub Actions section on the check docs.

- uses: actions/checkout@v2
  with: 
    fetch-depth: 0

I don't know if that fix is broadly applicable, but it worked in my repo and I see that Microsoft FAST uses it too.

Thanks, I actually noticed that this was broken in the beachball repo itself too (fixed in #558). 😆

I think in github repos, we should create a beachball github action itself that does this check & release for you ultimately...