Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Fix workflow events #17

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

joeyparrish
Copy link
Member

This was found by auditing workflows based on research published here:

https://github.com/joeyparrish/workflow-cheat-sheet

The research was prompted by a workflow bug in Shaka Streamer

This was found by auditing workflows based on research published here:

https://github.com/joeyparrish/workflow-cheat-sheet

The research was prompted by a workflow bug in Shaka Streamer
Copy link

@beback4u beback4u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Not familiar with actions/checkout but my understanding is the CL is trying to use the latest checkout v4 and explicitly picks the right release tag.

- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
ref: refs/tags/${{ steps.release.outputs.tag_name }}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

optional nit: It would be helpful if you put some reason why we need to add this additionally instead of the hyperlink.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe there is a race, since the default ${{ github.ref }} resolves to refs/heads/main. If another change is merged between the release PR and the workflow run, this could check out the wrong thing. Hence the change to an explicit ref built from the release tag name.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack, thanks!

@joeyparrish joeyparrish merged commit 9249e93 into shaka-project:main Nov 5, 2024
6 checks passed
@joeyparrish joeyparrish deleted the fix-workflow-events branch November 5, 2024 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants