Clarify setting HEAD SHA for GH Actions #763
Conversation
StephenBarlow
force-pushed
the
sb/gh-actions-checks
branch
from
f402c5c
to
886188d
Compare
|
@EverlastingBugstopper This stems from a support ticket where a user had an issue with checking against the GH merge commit instead of HEAD. I didn't encounter this same issue in my own project, but setting the SHA like this doesn't seem to hurt anything either! Thoughts? |
docs/source/ci-cd.md
Outdated
|
|
||
| <img class="screenshot" src="./assets/checks-result.jpg" width="550"/> | ||
|
|
||
| For these entries to display correctly, you need to make sure Rover executes against the pull request's `HEAD` commit, as opposed to the _merge_ commit that GitHub adds. To guarantee this, set the `APOLLO_VCS_COMMIT` environment variable in your action's configuration, like so: |
There was a problem hiding this comment.
"executes against" isn't exactly correct. you could say "make sure Rover reports the pull request's HEAD commit to Studio so that the check matches the commit expected by the Apollo Studio GitHub App". or something
There was a problem hiding this comment.
Ahh thanks, made an uneducated guess there 😄
|
Hmm, this almost seems like something we should just detect and do automatically. Is that too magic though? Docs are a great solution without such implementation done in the near-term though. |
|
Yes this has come up before - I think docs are a good solution here. Last time this came up I believe it was determined that it wasn't super possible to tell when was the right time to do this, but this comment on this thread is kinda illuminating on why GH Actions does this by default. |
StephenBarlow
force-pushed
the
sb/gh-actions-checks
branch
from
886188d
to
f45b890
Compare
No description provided.