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

Explicitly state that at least one job is required to run and that without, a workflow will fail #34338

Closed
wants to merge 1 commit into from

Conversation

MizouziE
Copy link

Why:

Closes: #34337

What's being changed:

The opening paragraph of the overview to:

A workflow run is made up of at least one or more jobs, which run in parallel by default. Without any jobs to run, a workflow will fail. To run jobs sequentially, you can define dependencies on other jobs using the jobs.<job_id>.needs keyword.

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

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

Explicitly state that at least one job is required to run and that without, a workflow will fail
Copy link

welcome bot commented Aug 18, 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 Aug 18, 2024
Copy link
Contributor

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/writing-workflows/choosing-what-your-workflow-does/using-jobs-in-a-workflow.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
from reusable
actions/writing-workflows/workflow-syntax-for-github-actions.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
from reusable

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

@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 Aug 19, 2024
@nguyenalex836
Copy link
Contributor

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

@subatoi
Copy link
Contributor

subatoi commented Aug 19, 2024

Hi @MizouziE, and thanks for your PR—

I'm afraid we won't be accepting this submission on this occasion:

  • The reusable you're proposing to update is only used in articles after where we'd expect this kind of disclaimer would be useful. For example, you can see under "Workflow basics" in "About workflows" that we say that a workflow "must contain" one or more jobs
  • The language "one or more", in any case, already implies that a minimum of one should be present

Thank you for your interest in the GitHub docs!

@subatoi subatoi closed this Aug 19, 2024
@MizouziE
Copy link
Author

Thanks for the reply and explanation @subatoi I appreciate your points. Just wanted to mention that it's possible that people land directly on the pages which are beyond the points addressed in the Workflow basics chapters (as was my case) and, as is always the case with documentation, that leaves the reader with a little less context than ideal.

Anyway, lesson learned and hopefully I'll form a better habit of gathering context beyond the scope of what it is I'm attempting to do.

@subatoi
Copy link
Contributor

subatoi commented Aug 19, 2024

Thanks for your engagement @MizouziE—I've reached out to the internal team in question with your feedback, and they may choose to take it further and make some amendments.

Please don't be discouraged from raising further contributions—just as a gentle point, it may help to raise an issue first next time, so we can have this kind of discussion there first.

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

Explicitly state that at least one job is required for a workflow
3 participants