Skip to content

Conversation

muzimuzhi
Copy link
Contributor

Why:

Closes: #40669

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

Update Actions job context example to include newly added property check_run_id.

The example check_run_id value is taken from this run, see also its persistent file.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Added 'check_run_id' property to job context example.
@Copilot Copilot AI review requested due to automatic review settings October 3, 2025 05:08
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the GitHub Actions documentation to include the newly added check_run_id property in the job context example. The update adds the property to both the descriptive text and the JSON example, ensuring the documentation accurately reflects the current API structure.

  • Updates the description to mention that minimal job contexts contain both status and check_run_id properties
  • Adds the check_run_id field to the JSON example with a real value from an actual workflow run
  • Uses conditional versioning to show the property only for GitHub.com and GitHub Enterprise Cloud

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 3, 2025
Copy link
Contributor

github-actions bot commented Oct 3, 2025

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
actions/reference/workflows-and-actions/contexts.md fpt
ghec
ghes@ 3.17 3.16 3.15 3.14
fpt
ghec
ghes@ 3.17 3.16 3.15 3.14

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

🤖 This comment is automatically generated.

@muzimuzhi
Copy link
Contributor Author

fpt
ghec
ghes@ 3.17 3.16 3.15 3.14

Somehow I got 404 error on all of the links in "Review" column, not particularly in this PR, but also in other PRs, even recently merged PRs.

@Sharra-writes
Copy link
Contributor

@muzimuzhi I'm not sure what's up with the review links, but the change to the article is a pretty small one that I'm inclined to accept at face value, so I'll get it added to the merge queue once the checks pass.

@Sharra-writes Sharra-writes added this pull request to the merge queue Oct 3, 2025
Merged via the queue into github:main with commit 30c55f3 Oct 3, 2025
41 checks passed
Copy link
Contributor

github-actions bot commented Oct 3, 2025

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

@aceoflandsoffree-gif
Copy link

aceoflandsoffree-gif commented Oct 3, 2025 via email

@muzimuzhi muzimuzhi deleted the check_run_id-example branch October 3, 2025 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New Actions context property job.check_run_id missing from the context content example
3 participants