search

tldr-pages / tldr-c-client

C command-line client for tldr pages
MIT License
293 stars 50 forks source link

ci: upgrade GitHub actions to Node.js v16 🚒 #89

Closed navarroaxel closed 2 years ago

navarroaxel commented 2 years ago

What does it do?

Upgrade the GitHub Actions to versions with node16 as runtime.

Why the change?

Node.js v12 is deprecated and the old versions use node12 as runtime.

How can this be tested?

Running the GitHub workflows for this repo.

MasterOdin commented 2 years ago

The PR title is also totally wrong for what this does 😞

navarroaxel commented 2 years ago

LGTM! But, out of interest, what's the benefit to removing the name? thinking

IMHO I prefer the action name (use) for common actions, or the run description if it's a simple command, because it's easier to see what kind of command is failing. An example from a project where I'm working:

  ✓ Set up job
  ✓ Run actions/checkout@v3
  ✓ Run actions/setup-node@v3
  ✓ Run npm ci --legacy-peer-deps
  ✓ Build Android Release
  ✓ Post Run actions/setup-node@v3
  ✓ Post Run actions/checkout@v3
  ✓ Complete job
navarroaxel commented 2 years ago

The PR title is also totally wrong for what this does disappointed

But I upgrade the runtime to node16 :thinking:. For me workflow is for this repo, action is a job step "tool" Do you think the node16 is ambiguous if it's talking about the repo or the runtime of the checkout action?

MasterOdin commented 2 years ago

"Update actions to latest versions" which is more descriptive, and then in the PR, say "the breaking change is that these actions now use the node16 runtime. This is incompatible with older self-hosted action runner versions, but since we're not using self-hosted runners, it doesn't matter".

Like, the runtime that a given action uses is just an implementation detail, and does not matter to the containing workflow. Like, they could have switched from the JS runtime to docker runtime instead, and I wouldn't expect the title to be "ci: upgrade GitHub actions to Docker". Treat upgrading the versions of actions the same as upgrading versions of any other dependency you might have in your repo.