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.

Sign up for GitHub

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

Jump to bottom

Use valid reusable workflow paths in example yml #15481

Merged
merged 2 commits into from
Mar 2, 2022
Merged

Use valid reusable workflow paths in example yml #15481

merged 2 commits into from
Mar 2, 2022

Conversation

Layoric
Copy link
Contributor

@Layoric Layoric commented Feb 15, 2022

Fix for #15480

The docs currently state:

Reusable workflows are YAML-formatted files, very similar to any other workflow file. As with other workflow files, you locate reusable workflows in the .github/workflows directory of a repository. Subdirectories of the workflows directory are not supported.

But the example yml then presents the path uses: ./.github/actions/my-action which doesn't follow the initial advice about location of workflow files.

Change is to use uses: ./.github/workflows/my-action to make example valid, but this is assuming the Creating a reusable workflow section is also accurate.

Why:

Closes [issue link]

What's being changed:

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@Layoric
Use valid reusable workflow paths in example yml
c9186d0 
The docs currently state:

> Reusable workflows are YAML-formatted files, very similar to any other workflow file. As with other workflow files, you locate reusable workflows in the `.github/workflows` directory of a repository. Subdirectories of the `workflows` directory are not supported.

But the example yml then presents the path `uses: ./.github/actions/my-action` which doesn't follow the initial advice about location of workflow files.

Change is to use `uses: ./.github/workflows/my-action` to make example valid, but this is assuming the `Creating a reusable workflow` section is also accurate.
@welcome
Copy link

welcome bot commented Feb 15, 2022

Thanks for opening this pull request! 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 Feb 15, 2022
@ramyaparimi ramyaparimi linked an issue Feb 15, 2022 that may be closed by this pull request
Provide consistent example yml for reusable workflows #15480
Closed
1 task
@ramyaparimi ramyaparimi added 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 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 Feb 15, 2022
@ramyaparimi
Copy link
Contributor

@Layoric
Thanks so much for opening a PR! I'll get this triaged for review ⚡

@ethomson
Copy link
Contributor

ethomson commented Mar 1, 2022

Oops! Good catch @Layoric - thanks for the fix! 👍

ramyaparimi
ramyaparimi approved these changes Mar 2, 2022
View reviewed changes
Copy link
Contributor

@ramyaparimi ramyaparimi left a comment

Choose a reason for hiding this comment

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

@Layoric
Thanks so much for opening a PR with this fix! I'll get this merged once tests are passing 🍏

@ramyaparimi ramyaparimi enabled auto-merge March 2, 2022 12:38
@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2022

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.

Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
content/actions/using-workflows/reusing-workflows.md Modified Original

@ramyaparimi ramyaparimi added the ready to merge This pull request is ready to merge label Mar 2, 2022
@ramyaparimi ramyaparimi merged commit 13de02d into github:main Mar 2, 2022
@github-actions
Copy link
Contributor

github-actions bot commented Mar 2, 2022

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

@dne dne mentioned this pull request Aug 17, 2022
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ramyaparimi ramyaparimi ramyaparimi approved these changes

Assignees
No one assigned
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 ready to merge This pull request is ready to merge waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Provide consistent example yml for reusable workflows
3 participants
@Layoric @ramyaparimi @ethomson