GHA check sdk-go compatibility #200
Conversation
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Validate inputs |
There was a problem hiding this comment.
Probably redundant since the checkout step will fail if the ref isn't valid.
There was a problem hiding this comment.
I need to at least translate the "latest" input to an actual tag. The checkout step fails with the "latest" ref.
There was a problem hiding this comment.
Got it, yeah, I had it in my head that we want to verify master and not latest, but I think latest is right.
We need to give guidance though that sometimes latest is expected to fail, e.g. when making backwards incompatible changes, and that the action should be rerun with master. If that also fails, we should not cut a release.
| API_REF: ${{ github.event.inputs.api_ref }} | ||
| run: | | ||
| if [[ "$SDK_REF" == "latest" ]]; then | ||
| SDK_REF=$(gh api /repos/temporalio/sdk-go/releases/latest --jq '.name') |
There was a problem hiding this comment.
I see you're using the GH_TOKEN env var so probably not much of a concern but this command may get rate limited by GH.
I vote for removing this step to have one less moving part.
There was a problem hiding this comment.
The rate limit is 15000 requests per hour: https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28#primary-rate-limit-for-github_token-in-github-actions
| env: | ||
| API_REF: ${{ steps.inputs.outputs.API_REF }} | ||
| run: | | ||
| for f in $(find . -iname go.mod); do |
There was a problem hiding this comment.
I wonder if any of the commands in this loop fail, will this shell script error out or will these failures be silent?
There was a problem hiding this comment.
It will error out.
|
This should run before a release is tagged and it's too late. |
I requested it be put in here so it can be updated by anyone using this repo that may need to change instead of just something owned by the SDK team, and it's a condition on this repo not the SDK one. Granted we plan on making sure the Go SDK updates to latest API release on each release it makes as an inverse condition. |
|
Works for me. I think the first 3 can be part of the same workflow or workflow triggers we have here and in other PRs. |
What changed?
GHA check sdk-go compatibility
Why?
Automation: be able to check if a api-go version breaks sdk-go
How did you test it?
Potential risks