docs icon indicating copy to clipboard operation
docs copied to clipboard

Document runner.debug

Open JustinGrote opened this issue 3 years ago • 5 comments

Why:

Document the runner.debug property, which exists and is useful for triggering actions only when "Enable Debug Logging" is enabled on a job re-run.

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

Add an entry to the table to describe the runner.debug attribute and when it is useful.

Check off the following:

  • [X] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [X] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • [ ] I have added the 'writer impact' label
    • [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

JustinGrote avatar Jul 29 '22 21:07 JustinGrote

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 Jul 29 '22 21:07 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/learn-github-actions/contexts.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
actions/learn-github-actions/environment-variables.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

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

github-actions[bot] avatar Jul 29 '22 21:07 github-actions[bot]

Thanks for opening a PR :+1: Please fill out the pull request template in the top comment in this pull request, then we'll get this up for review!

cmwilson21 avatar Aug 03 '22 16:08 cmwilson21

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

github-actions[bot] avatar Aug 10 '22 16:08 github-actions[bot]

@JustinGrote thanks for filling in the template! I'll get this triaged for review.

Our actions team may be a little slow to respond right now, so we appreciate your patience! :yellow_heart:

cmwilson21 avatar Aug 10 '22 19:08 cmwilson21

Thanks for this, @JustinGrote! I made a few edits for clarity:

  • There is also an equivalent environment variable set in the runner OS.
  • Mentioned that it is only set when debug logging is enabled (e.g. the context/envar does not exist when it isn't enabled.).

lucascosti avatar Aug 17 '22 06:08 lucascosti

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 Aug 17 '22 07:08 github-actions[bot]

Thanks for this, @JustinGrote! I made a few edits for clarity:

  • There is also an equivalent environment variable set in the runner OS.
  • Mentioned that it is only set when debug logging is enabled (e.g. the context/envar does not exist when it isn't enabled.).

Hi Lucas,

Thanks! Also important to note that the variable isn't referenceable by the env. syntax in an Action, that tripped me up for a while.

JustinGrote avatar Aug 17 '22 11:08 JustinGrote

Also important to note that the variable isn't referenceable by the env. syntax in an Action, that tripped me up for a while.

Yep, when to use environment variables vs. contexts is a bit confusing. We have advice here and here that hopefully explains why/when environment variables can't be used in a workflow file.

lucascosti avatar Aug 18 '22 01:08 lucascosti