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

Release workflow maintenance #902

Merged

Conversation

kennethloeffler
Copy link
Member

@kennethloeffler kennethloeffler commented Apr 11, 2024

This PR performs a number of relatively straightforward maintenance tasks and improvements for the "Release" workflow:

  • Upgrades to actions/checkout@v4 and switches to dtolnay/rust-toolchain instead in favor of actions-rs/toolchain

    Reasoning is the same as Use dtolnay/rust-toolchain and upgrade to checkout v4 in CI workflow #900

  • Switches to softprops/create-gh-release

    actions/create-release is unmaintained and has been archived for more than three years.

    I considered using the GitHub CLI's (which is preinstalled on GitHub-hosted runners)gh release create to do this so we wouldn't have to pull in another third-party action, but it requires a checkout first - but doing this only adds a few more seconds before the release is created comapred to create-gh-release, so it may be acceptable?

  • Switches to using preinstalled GitHub CLI to upload release archives

    There's absolutely no point in using a third party action for this, so we won't!

  • Simplifies the and consolidates the way we generate names for release archives

Here's an example of the results of this workflow on my fork:
https://github.com/kennethloeffler/rojo/actions/runs/8642870695
https://github.com/kennethloeffler/rojo/releases/tag/v7.4.0-releasevvv-workflow-tewstingsbvv

@kennethloeffler kennethloeffler added the skip changelog PRs that may skip the changelog enforcement check label Apr 11, 2024
@Dekkonot
Copy link
Member

Does using GitHub's CLI for creating a release substantially increase the complexity? Glancing at the docs makes me think no, and it's probably worth using it over an action even if it adds a small delay.

Otherwise, I like the changes and thank you for taking care of this. Touching workflows is always work I want to do but never get around to.

Checkout

Title

Correct ref
Comment on lines +16 to +17
run: |
gh release create ${{ github.ref_name }} --draft --verify-tag --title ${{ github.ref_name }}
Copy link
Member Author

Choose a reason for hiding this comment

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

The command is quite simple, so we may as well do it

Here are the results of this revision:
https://github.com/kennethloeffler/rojo/actions/runs/8657764221 (I had to re-run the macOS ARM job because I got rate limited, but the rest of the artifacts are visible in the previous run)
https://github.com/kennethloeffler/rojo/releases/tag/v7.4.0-release-workflow-testing-2

@Dekkonot Dekkonot merged commit ce71a3d into rojo-rbx:master Apr 17, 2024
6 checks passed
@kennethloeffler kennethloeffler deleted the release-workflow-maintenance branch April 17, 2024 18:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changelog PRs that may skip the changelog enforcement check
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants