Default debug to current runner debug state #363

mjpieters · 2023-04-05T12:54:43Z

When the action 'debug' input is not set, default to the current runner debug state. This ensures that the Octokit client request logs are included automatically when you re-run a job with debug enabled.

Note that the integration test for the 'debug' option is now a matrix test, to cover both the runner debug mode being disabled and enabled; you have to set the RUNNER_DEBUG env variable in a separate step because step.<step-id>.env is evaluated after any action with: block.

Fixes #264

action.yml

mjpieters · 2023-04-05T12:59:13Z

Well, explitive bleeped out:

Error: /home/runner/work/github-script/github-script/./action.yml (Line: 17, Col: 14): Unrecognized named-value: 'env'. > Located at position 2 within expression: (env.RUNNER_DEBUG == '1' && 'true') || 'false'

So actually, no, we can't use env.RUNNER_DEBUG in an action default.

TWiStErRob · 2023-04-05T13:25:40Z

docs: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddefault
I can't find anything on what's the syntax/possibilities for this :(

default: '' + #264 (comment) still does the job, right? It's just not as nice.

mjpieters · 2023-04-05T13:46:36Z

#0docs: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddefault I can't find anything on what's the syntax/possibilities for this :(

default: '' + #264 (comment) still does the job, right? It's just not as nice.

#0docs: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#inputsinput_iddefault
I can't find anything on what's the syntax/possibilities for this :(

Took me a while, but I finally found the actions yaml definitions, which has a list of available contexts:

        "input-default-context": {
            "context": [
                "github",
                "strategy",
                "matrix",
                "job",
                "runner",
                "hashFiles(1,255)"
            ],
            "string": {}
        },

The good news is that runner.debug also exists! The bad news is that I am not sure we can then force the flag in an integration test, not without explicitly setting the ACTIONS_STEP_DEBUG secret for a workflow.

I'll update the PR and see what happens.

mjpieters · 2023-04-05T13:54:15Z

Right, we can use runner.debug, but can't cover that flag changing in an automated test. Admins of this repo can re-run the integration tests with debugging enabled to verify that the test still passes, so it works as a manual test.

mjpieters · 2023-04-05T14:00:04Z

I've recreated this PR in my fork, running the integration test workflow. I then re-ran that workflow with debug enabled to confirm this does what it says it does, see https://github.com/mjpieters/github-script/actions/runs/4619285497/jobs/8167847845#step:5:46

The debug log records the inputs given to the action as:

  with:
    script: const log = github.log
  return {
    runnerDebugMode: core.isDebug(),
    debug: log.debug === console.debug,
    info: log.info === console.info
  }
  
    github-token: ***
    debug: true
    user-agent: actions/github-script
    result-encoding: json
    retries: 0
    retry-exempt-status-codes: 400,401,403,404,422

.github/workflows/integration.yml

action.yml

.github/workflows/integration.yml

When the action 'debug' input is not set, default to the current runner debug state. This ensures that the Octokit client request logs are included automatically when you re-run a job with debug enabled.

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) #### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) #### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/JoshuaKGoldberg/template-typescript-node-package).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) ##### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) ##### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/JoshuaKGoldberg/ts-api-utils).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) ##### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) ##### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/JellyfishSDK/jellyfish).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

…-script#363)

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script (actions/github-script)</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) #### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) #### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/Hapag-Lloyd/terraform-aws-bastion-host-ssm).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[![Mend Renovate logo banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/github-script](https://togithub.com/actions/github-script) | action | patch | `v6.4.0` -> `v6.4.1` | --- ### Release Notes <details> <summary>actions/github-script (actions/github-script)</summary> ### [`v6.4.1`](https://togithub.com/actions/github-script/releases/tag/v6.4.1) [Compare Source](https://togithub.com/actions/github-script/compare/v6.4.0...v6.4.1) #### What's Changed - Add [@octokit/plugin-request-log](https://togithub.com/octokit/plugin-request-log), to produce debug output for requests by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) - fix input handling by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/357](https://togithub.com/actions/github-script/pull/357) - Remove unused dependencies by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/356](https://togithub.com/actions/github-script/pull/356) - Default debug to current runner debug state by [@mjpieters](https://togithub.com/mjpieters) in [https://github.com/actions/github-script/pull/363](https://togithub.com/actions/github-script/pull/363) #### New Contributors - [@mjpieters](https://togithub.com/mjpieters) made their first contribution in [https://github.com/actions/github-script/pull/358](https://togithub.com/actions/github-script/pull/358) **Full Changelog**: actions/github-script@v6.4.0...v6.4.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/Hapag-Lloyd/dist-comm-vis).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Bumps [actions/github-script](https://github.com/actions/github-script) from 6.4.0 to 7.0.1. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/actions/github- script/releases">actions/github-script's releases</a>.</em></p> <blockquote> <h2>v7.0.1</h2> <h2>What's Changed</h2> <ul> <li>Avoid setting <code>baseUrl</code> to undefined when input is not provided by <a href="https://github.com/joshmgross"><code>@joshmgross</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/439">actions/github-script#439</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/github- script/compare/v7.0.0...v7.0.1">https://github.com/actions/github- script/compare/v7.0.0...v7.0.1</a></p> <h2>v7.0.0</h2> <h2>What's Changed</h2> <ul> <li>Add base-url option by <a href="https://github.com/robandpdx"><code>@robandpdx</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/429">actions/github-script#429</a></li> <li>Expose async-function argument type by <a href="https://github.com/viktorlott"><code>@viktorlott</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/402">actions/github-script#402</a>, see for details <a href="https://github.com/actions/github-script#use-scripts-with-jsdoc- support">https://github.com/actions/github-script#use-scripts-with- jsdoc-support</a></li> <li>Update dependencies and use Node 20 by <a href="https://github.com/joshmgross"><code>@joshmgross</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/425">actions/github-script#425</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/navarroaxel"><code>@navarroaxel</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/285">actions/github-script#285</a></li> <li><a href="https://github.com/robandpdx"><code>@robandpdx</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/429">actions/github-script#429</a></li> <li><a href="https://github.com/viktorlott"><code>@viktorlott</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/402">actions/github-script#402</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/github- script/compare/v6.4.1...v7.0.0">https://github.com/actions/github- script/compare/v6.4.1...v7.0.0</a></p> <h2>v6.4.1</h2> <h2>What's Changed</h2> <ul> <li>Add <code>@octokit/plugin-request-log</code>, to produce debug output for requests by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/358">actions/github-script#358</a></li> <li>fix input handling by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/357">actions/github-script#357</a></li> <li>Remove unused dependencies by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/356">actions/github-script#356</a></li> <li>Default debug to current runner debug state by <a href="https://github.com/mjpieters"><code>@mjpieters</code></a> in <a href="https://redirect.github.com/actions/github- script/pull/363">actions/github-script#363</a></li> </ul> <h2>New Contributors</h2> <ul> <li><a href="https://github.com/mjpieters"><code>@mjpieters</code></a> made their first contribution in <a href="https://redirect.github.com/actions/github- script/pull/358">actions/github-script#358</a></li> </ul> <p><strong>Full Changelog</strong>: <a href="https://github.com/actions/github- script/compare/v6.4.0...v6.4.1">https://github.com/actions/github- script/compare/v6.4.0...v6.4.1</a></p> </blockquote> </details> <details> <summary>Commits</summary> <ul> <li><a href="actions/github-script@60a0d83039c 74a4aee543508d2ffcb1c3799cdea"><code>60a0d83</code></a> Merge pull request <a href="https://redirect.github.com/actions/github- script/issues/440">sagemath#440</a> from actions/joshmgross/v7.0.1</li> <li><a href="actions/github-script@b7fb2001b41 0c9390cbe9e2c7d5cab7eefb7b29c"><code>b7fb200</code></a> Update version to 7.0.1</li> <li><a href="actions/github-script@12e22ed06b6 cf302663f90a925045516e24c8bad"><code>12e22ed</code></a> Merge pull request <a href="https://redirect.github.com/actions/github- script/issues/439">sagemath#439</a> from actions/joshmgross/avoid-setting-base- url</li> <li><a href="actions/github-script@d319f8f5b55 ea40916b869b2ca9ae2f059c60abf"><code>d319f8f</code></a> Avoid setting <code>baseUrl</code> to undefined when input is not provided</li> <li><a href="actions/github-script@e69ef5462fd 455e02edcaf4dd7708eda96b9eda0"><code>e69ef54</code></a> Merge pull request <a href="https://redirect.github.com/actions/github- script/issues/425">sagemath#425</a> from actions/joshmgross/node-20</li> <li><a href="actions/github-script@ee0914b839b 704083a749f8c77a73a9270674a32"><code>ee0914b</code></a> Update licenses</li> <li><a href="actions/github-script@d6fc56f33b0 17d55917d045da1a94efa2120f039"><code>d6fc56f</code></a> Use <code>@types/node</code> for Node 20</li> <li><a href="actions/github-script@384d6cf5814 52587d1e31f553c97ab165427124a"><code>384d6cf</code></a> Fix quotations in tests</li> <li><a href="actions/github-script@84724927e3e 992f17768c17f57a47a85ea2a5160"><code>8472492</code></a> Only validate GraphQL <code>previews</code></li> <li><a href="actions/github-script@84903f51828 821af5d03d3884c6ba699a2d44d6e"><code>84903f5</code></a> Remove <code>node-fetch</code> from type</li> <li>Additional commits viewable in <a href="https://github.com/actions/github- script/compare/v6.4.0...v7.0.1">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot- badges.githubapp.com/badges/compatibility_score?dependency- name=actions/github-script&package-manager=github_actions&previous- version=6.4.0&new- version=7.0.1)](https://docs.github.com/en/github/managing-security- vulnerabilities/about-dependabot-security-updates#about-compatibility- scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> URL: sagemath#36739 Reported by: dependabot[bot] Reviewer(s): Kwankyu Lee

mjpieters requested a review from a team April 5, 2023 12:54

TWiStErRob reviewed Apr 5, 2023

View reviewed changes

action.yml Outdated Show resolved Hide resolved

TWiStErRob reviewed Apr 5, 2023

View reviewed changes

.github/workflows/integration.yml Outdated Show resolved Hide resolved

joshmgross reviewed Apr 5, 2023

View reviewed changes

action.yml Outdated Show resolved Hide resolved

mjpieters temporarily deployed to debug-integration-test April 5, 2023 16:14 — with GitHub Actions Inactive

mjpieters temporarily deployed to debug-integration-test April 5, 2023 16:16 — with GitHub Actions Inactive

joshmgross approved these changes Apr 5, 2023

View reviewed changes

.github/workflows/integration.yml Outdated Show resolved Hide resolved

Default debug to current runner debug state

ea954ff

When the action 'debug' input is not set, default to the current runner debug state. This ensures that the Octokit client request logs are included automatically when you re-run a job with debug enabled.

mjpieters temporarily deployed to debug-integration-test April 5, 2023 16:26 — with GitHub Actions Inactive

joshmgross approved these changes Apr 5, 2023

View reviewed changes

joshmgross merged commit d7906e4 into actions:main Apr 5, 2023

mjpieters deleted the auto_debug branch April 5, 2023 20:40

AbsolytnaiaLove approved these changes Jun 18, 2023

View reviewed changes

TWiStErRob added a commit to TWiStErRob/net.twisterrob.sun that referenced this pull request Sep 14, 2023

Remove unnecessary env var, it's been fixed in v6.4.1 (actions/github…

3726de5

…-script#363)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Default debug to current runner debug state #363

Default debug to current runner debug state #363

Default debug to current runner debug state #363

Default debug to current runner debug state #363

Conversation