Default debug to current runner debug state

[mjpieters]

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

[mjpieters]

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]

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]

#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]

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]

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