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

GitHub Actions updates #554

Merged
merged 3 commits into from
Jun 25, 2024
Merged

Conversation

jgarber623
Copy link
Contributor

@jgarber623 jgarber623 commented Jun 12, 2024

Description

This PR updates some of this project's workflows to use newer versions of official reusable actions:

In both cases, the updates should address deprecation notices on the changed workflows.

Future Considerations

There are a few things I opted not to do as part of this PR:

Fixing formatting and indentation in workflow YML files. I ignored this for now as it would introduce a much larger diff and would obscure the meaningful changes.

Migrating from archived actions to maintained replacements. In 2021, GitHub archived two of the actions used by this project:

That's rather bothersome. Both of those actions are generating deprecation warnings and could stop working at some point in the future altogether.

Some ideas:

  1. Transition the "release" workflow to trigger on the creation of a Release rather than on tag creation. This may be done either via the web UI or the CLI (e.g. gh release create v1.2.3 --generate-notes). Creating a Release will generate a tag and I think much of the existing "release" workflow can remain the same. That is a process change, though.

  2. Replace the use of actions/upload-release-asset with an equivalent using the GitHub CLI. The CLI is available on GitHub-provided runners and can use the REST API to push an asset (documentation). I haven't tried this myself, but the pieces should all be there.

I'd be happy to PR either or both of the above, further document them in an Issue, and/or put together a quick demo repo of the process.

This _might_ address the failed workflow runs dating back to at least
the last six months:

https://github.com/maxgoedjen/secretive/actions/workflows/add-to-project.yml
This should get rid of the deprecation notices displayed as annotations
beneath each Nightly job run. See:

https://github.com/maxgoedjen/secretive/actions/runs/9461831554
Similar to cf25db6, this should silence some deprecation notices.
Copy link
Owner

@maxgoedjen maxgoedjen left a comment

Choose a reason for hiding this comment

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

Thanks @jgarber623!

@maxgoedjen maxgoedjen enabled auto-merge (squash) June 25, 2024 21:07
@maxgoedjen maxgoedjen merged commit a543de0 into maxgoedjen:main Jun 25, 2024
1 check passed
@maxgoedjen
Copy link
Owner

WRT the ideas mentioned: the main idea here is to have all of that happen in a visible place (ie, on CI) vs locally – I'm not opposed to this in theory if it's runnable on the CI, although I'd lean towards just leaving as-is until it becomes an issue personally.

@jgarber623 jgarber623 deleted the github-actions-updates branch June 26, 2024 23:58
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.

None yet

2 participants