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

Document jobs.<job_id>.defaults.run.working-directory #31970

Merged
merged 11 commits into from Mar 12, 2024
Merged

Document jobs.<job_id>.defaults.run.working-directory #31970

merged 11 commits into from Mar 12, 2024

Conversation

jsoref
Copy link
Contributor

@jsoref jsoref commented Mar 6, 2024

  • Documents jobs.<job_id>.defaults.run.shell
  • Refactors a number of elements into data.reusables
  • Adds warning that working-directory must exist

Why:

Closes: #31346

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

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.

@jsoref
Document jobs.<job_id>.defaults.run.working-directory
523f2af 
* Documents `jobs.<job_id>.defaults.run.shell`
* Refactors a number of elements into data.reusables
* Adds warning that `working-directory` must exist
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 6, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 6, 2024 •
edited

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/using-workflows/workflow-syntax-for-github-actions.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

@nguyenalex836
Copy link
Contributor

@jsoref Hello! 👋 Let us know once this PR is ready for review

@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 more-information-needed More information is needed to complete review and removed triage Do not begin working on this issue until triaged by the team labels Mar 7, 2024
@jsoref
Copy link
Contributor Author

jsoref commented Mar 7, 2024

I suspect it's ready now (I needed that one rendering to figure out dashes...)

@nguyenalex836
Copy link
Contributor

@jsoref Roger that! I'll move this to "ready for review" status and triage for review shortly 👍

@nguyenalex836 nguyenalex836 marked this pull request as ready for review March 7, 2024 21:33
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review and removed more-information-needed More information is needed to complete review labels Mar 7, 2024
SiaraMist
SiaraMist reviewed Mar 12, 2024
View reviewed changes
Copy link
Contributor

@SiaraMist SiaraMist left a comment

Choose a reason for hiding this comment

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

Hey @jsoref, thanks for opening this PR!

I left a couple of comments to point out some information I think we should remove. I wanted to give you a chance to respond, so I'm not merging this PR yet. But once we remove the information or decide on an alternative, I will approve this and get it merged. Thanks again for improving the docs!

data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-run-shell.md Outdated Show resolved Hide resolved
data/reusables/actions/working-directory-must-exist.md Outdated Show resolved Hide resolved
data/reusables/actions/jobs/setting-default-values-for-jobs-defaults-run-working-directory.md Outdated Show resolved Hide resolved
jsoref and others added 2 commits March 12, 2024 16:48
@jsoref @SiaraMist
Apply suggestions from code review
51a1756 
Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com>
@SiaraMist
Merge branch 'main' into issue-31346
8fe7b22
@SiaraMist SiaraMist added this pull request to the merge queue Mar 12, 2024
Merged via the queue into github:main with commit bb5537e Mar 12, 2024
41 checks passed
@github-actions GitHub Actions
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 ⚡

@jsoref jsoref deleted the issue-31346 branch March 13, 2024 00:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

Please document jobs.<job_id>.defaults.run.working-directory because it's important
3 participants
@jsoref @nguyenalex836 @SiaraMist