You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
jsoref opened this issue
Jul 19, 2024
· 5 comments
Labels
actionsThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamneeds SMEThis proposal needs review from a subject matter expert
What part(s) of the article would you like to see updated?
runs.pre should include a paragraph explaining availability caveats.
It should mention:
pre doesn't work from local actions
If you create an action that will be used by other actions that might in turn be used by local actions, you'll trigger warnings in all workflows that use that action.
that better practice involves creating a secondary action containing the pre phase so it can optionally be used at the discretion of consumer actions/workflows.
@ncalteen struggled to explain the problem to the various people who complained about the confusing behavior.
Documentation here would have helped since at least @zijchen would have known that it wasn't going to work.
Documentation here might have also discouraged people from adding pre to actions.
Instead, the right behavior which should be recommended in resolving this ticket is to provide a second action in the same repository responsible for the pre behavior.
Thus, instead of @MoChilia in Azure/login#384 changing azure/login to have a pre thing which triggers warnings as noted in actions/runner#3397, @MoChilia could have created azure/login/clear-credentials which does the work that's currently included in pre. Then users could do:
uses: azure/login/clear-credentials@...
uses: azure/login@...
uses: azure/login@...
And groups like microsoft/playwright could uses: azure/login@... without triggering dozens of warnings.
Fwiw. I'm pretty sure I've run across other repositories causing similar headaches in the past. It's really frustrating, and given that it appears some actions authors really do refer to documentation, documentation is the right place to put advice to avoid this problem.
The text was updated successfully, but these errors were encountered:
nguyenalex836
added
actions
This issue or pull request should be reviewed by the docs actions team
waiting for review
Issue/PR is waiting for a writer's review
and removed
triage
Do not begin working on this issue until triaged by the team
labels
Jul 19, 2024
actionsThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamneeds SMEThis proposal needs review from a subject matter expert
Code of Conduct
What article on docs.github.com is affected?
https://github.com/github/docs/blob/main/content/actions/creating-actions/metadata-syntax-for-github-actions.md#runspre
What part(s) of the article would you like to see updated?
runs.pre
should include a paragraph explaining availability caveats.It should mention:
pre
doesn't work from local actionspre
phase so it can optionally be used at the discretion of consumer actions/workflows.Additional information
pre
execution is not supported for local action from './' actions/typescript-action#564 and referenced this documentation.Documentation here would have helped since at least @zijchen would have known that it wasn't going to work.
Documentation here might have also discouraged people from adding
pre
to actions.Instead, the right behavior which should be recommended in resolving this ticket is to provide a second action in the same repository responsible for the
pre
behavior.Thus, instead of @MoChilia in Azure/login#384 changing
azure/login
to have apre
thing which triggers warnings as noted in actions/runner#3397, @MoChilia could have createdazure/login/clear-credentials
which does the work that's currently included inpre
. Then users could do:And groups like microsoft/playwright could
uses: azure/login@...
without triggering dozens of warnings.Fwiw. I'm pretty sure I've run across other repositories causing similar headaches in the past. It's really frustrating, and given that it appears some actions authors really do refer to documentation, documentation is the right place to put advice to avoid this problem.
The text was updated successfully, but these errors were encountered: