docs icon indicating copy to clipboard operation
docs copied to clipboard

Clarify GITHUB_SHA for push event

Open dannycjones opened this issue 1 year ago • 3 comments

Why:

Simple clarification on the value of GITHUB_SHA for push event. It's fairly obvious but with this change, there's no room for ambiguity.

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

Just clarifying the content of GITHUB_SHA. First sentence under GITHUB_SHA is newly added.

Webhook event payload Activity types GITHUB_SHA GITHUB_REF
push Not applicable Commit pushed to the ref. When you delete a branch, the SHA in the workflow run (and its associated refs) reverts to the default branch of the repository. Updated ref

Check off the following:

  • [x] 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.
  • [x] For content changes, I have completed the self-review checklist.

dannycjones avatar Aug 29 '24 08:08 dannycjones

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.

welcome[bot] avatar Aug 29 '24 08:08 welcome[bot]

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-when-your-workflow-runs/events-that-trigger-workflows.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

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

github-actions[bot] avatar Aug 29 '24 08:08 github-actions[bot]

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

nguyenalex836 avatar Aug 29 '24 19:08 nguyenalex836

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Sep 17 '24 14:09 github-actions[bot]

@dannycjones Thank you so much for your patience while our SME team reviewed! They found a small to the wording would offer increased clarity, which I have added as a suggestion 💛

Once that suggestion has been applied, we will be happy to get this merged!

nguyenalex836 avatar Oct 08 '24 16:10 nguyenalex836

Thanks @nguyenalex836, I incorporated the feedback and also merged from main.

dannycjones avatar Oct 09 '24 20:10 dannycjones

@dannycjones Thank you for applying that suggestion! I'll update the branch and get this merged once tests are passing 🍏

nguyenalex836 avatar Oct 09 '24 21:10 nguyenalex836

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 :zap:

github-actions[bot] avatar Oct 09 '24 21:10 github-actions[bot]