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

Fix misleading example of reusable workflows #19904

Closed
1 task done
dne opened this issue Aug 17, 2022 · 4 comments · Fixed by #20324
Closed
1 task done

Fix misleading example of reusable workflows #19904

dne opened this issue Aug 17, 2022 · 4 comments · Fixed by #20324
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue waiting for review Issue/PR is waiting for a writer's review

Comments

@dne
Copy link

dne commented Aug 17, 2022

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/using-workflows/reusing-workflows

What part(s) of the article would you like to see updated?

The example reusable workflow in this article can lead newcomers to mix up reusable workflows with local actions.

A recent change from #15481 made this worse/more misleading. I propose to at least revert c9186d0 and maybe add a comment that the example references an action not a reusable workflow.

Additional information

I just spent some time trying (and failing) to use a reusable workflow as a step in a workflow job because I was mislead by this example, as have other users apparently.

@dne dne added the content This issue or pull request belongs to the Docs Content team label Aug 17, 2022
@welcome
Copy link

welcome bot commented Aug 17, 2022

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 17, 2022
@cmwilson21
Copy link
Contributor

@dne Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@cmwilson21 cmwilson21 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 Aug 17, 2022
@lucascosti lucascosti added the help wanted Anyone is welcome to open a pull request to fix this issue label Aug 22, 2022
@lucascosti
Copy link
Contributor

👋 @dne, thanks a lot for pointing this out! You are 100% correct; feel free for yourself (or anyone) to open a PR. Otherwise I should get to it in the next few days.

@joshjohanning
Copy link
Contributor

Just PR'd this in #20324

I removed the local action reference entirely since I agree, it's messy at best.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants
@dne @lucascosti @joshjohanning @cmwilson21 and others