-
Notifications
You must be signed in to change notification settings - Fork 60.1k
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
Clarified .github/workflows
name importance in quickstart.md
#31837
Conversation
When saying "_In the `.github/workflows` directory, create a file named `github-actions-demo.yml`_", it's important to distinguish what is a "magic name" (i.e., the `.github/workflows` subfolder, which must be named this way to be picked up by GitHub Actions) and the `github-actions-demo.yml` file of which the name does not matter (just the YAML format, and that it follows specifications).
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. |
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 changesYou 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.
fpt: Free, Pro, Team |
@jlumbroso Thanks so much for opening a PR! I'll get this triaged for review ✨ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for these clarifications! I made some minor wording changes that I'll go head and incorporate, then we'll get this merged for you.
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 ⚡ |
Thank you very much @skedwards88, that was super fast! 🙏🏻 |
Why:
When saying "In the
.github/workflows
directory, create a file namedgithub-actions-demo.yml
", it's important to distinguish what is a "magic name" (i.e., the.github/workflows
subfolder, which must be named this way to be picked up by GitHub Actions) and thegithub-actions-demo.yml
file of which the name does not matter (just the YAML format, and that it follows specifications).Closes:
What's being changed (if available, include any code snippets, screenshots, or gifs):
.github/workflows
directory has special meaning to {% data variables.product.prodname_dotcom %} - any file placed is automatically discovered and registered as a workflow.".yml
or.yaml
."Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR): preview link
data
directory.For content changes, I have completed the self-review checklist.