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

Clarified .github/workflows name importance in quickstart.md #31837

Merged
merged 5 commits into from
Feb 27, 2024

Conversation

jlumbroso
Copy link
Contributor

@jlumbroso jlumbroso commented Feb 25, 2024

Why:

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).

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

  • Added the sentence: "The .github/workflows directory has special meaning to {% data variables.product.prodname_dotcom %} - any file placed is automatically discovered and registered as a workflow."
  • Added the sentence: "The name of this file does not matter as long as it ends in .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

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

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).
Copy link

welcome bot commented Feb 25, 2024

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 25, 2024
Copy link
Contributor

github-actions bot commented Feb 25, 2024

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
actions/quickstart.md fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8
fpt
ghec
ghes@ 3.12 3.11 3.10 3.9 3.8

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@jlumbroso jlumbroso marked this pull request as ready for review February 26, 2024 14:31
@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team 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 Feb 26, 2024
@nguyenalex836
Copy link
Contributor

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

Copy link
Contributor

@skedwards88 skedwards88 left a 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.

content/actions/quickstart.md Outdated Show resolved Hide resolved
content/actions/quickstart.md Outdated Show resolved Hide resolved
@skedwards88 skedwards88 added the ready to merge This pull request is ready to merge label Feb 27, 2024
@skedwards88 skedwards88 added this pull request to the merge queue Feb 27, 2024
Merged via the queue into github:main with commit 50092ed Feb 27, 2024
49 checks passed
Copy link
Contributor

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

@jlumbroso
Copy link
Contributor Author

Thank you very much @skedwards88, that was super fast! 🙏🏻

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 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
Development

Successfully merging this pull request may close these issues.

3 participants