actions
/
toolkit
mirror of https://github.com/actions/toolkit
1
0
Fork 0
Code

Fix documentation links (#217)

pull/250/head
Peter Evans 2019-12-10 23:11:03 +09:00 committed by Ross Brodbeck
parent 1d7e38e56d
commit be9f18b69f
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/enhancement_request.md vendored
View File

@ -11,7 +11,7 @@ Thank you 🙇‍♀ for wanting to create an issue in this repository. Before y
* If you have found a security issue [please submit it here](https://hackerone.com/github) * If you have found a security issue [please submit it here](https://hackerone.com/github)
* If you have questions about writing workflows or action files, then please [visit the GitHub Community Forum's Actions Board](https://github.community/t5/GitHub-Actions/bd-p/actions) * If you have questions about writing workflows or action files, then please [visit the GitHub Community Forum's Actions Board](https://github.community/t5/GitHub-Actions/bd-p/actions)
* If you are having an issue or question about GitHub Actions then please [contact customer support](https://help.github.com/en/articles/about-github-actions#contacting-support) * If you are having an issue or question about GitHub Actions then please [contact customer support](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-github-actions#contacting-support)
If your issue is relevant to this repository, please include the information below: If your issue is relevant to this repository, please include the information below:

8
docs/action-debugging.md
View File

@ -11,9 +11,9 @@ Each file contains different logging information that corresponds to that proces
These files contain the prefix `Runner_` or `Worker_` to indicate the log source. These files contain the prefix `Runner_` or `Worker_` to indicate the log source.
### How to Access Runner Diagnostic Logs ### How to Access Runner Diagnostic Logs
These log files are enabled by [setting the secret](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) `ACTIONS_RUNNER_DEBUG` to `true`. These log files are enabled by [setting the secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets) `ACTIONS_RUNNER_DEBUG` to `true`.
All actions ran while this secret is enabled contain additional diagnostic log files in the `runner-diagnostic-logs` folder of the [log archive](https://help.github.com/en/articles/managing-a-workflow-run#downloading-logs-and-artifacts). All actions ran while this secret is enabled contain additional diagnostic log files in the `runner-diagnostic-logs` folder of the [log archive](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run#downloading-logs-and-artifacts).
## Step Debug Logs ## Step Debug Logs
Step debug logs increase the verbosity of a job's logs during and after a job's execution to assist with troubleshooting. Step debug logs increase the verbosity of a job's logs during and after a job's execution to assist with troubleshooting.
@ -21,6 +21,6 @@ Step debug logs increase the verbosity of a job's logs during and after a job's
Additional log events with the prefix `::debug::` will now also appear in the job's logs. Additional log events with the prefix `::debug::` will now also appear in the job's logs.
### How to Access Step Debug Logs ### How to Access Step Debug Logs
This flag can be enabled by [setting the secret](https://help.github.com/en/articles/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables) `ACTIONS_STEP_DEBUG` to `true`. This flag can be enabled by [setting the secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets#creating-encrypted-secrets) `ACTIONS_STEP_DEBUG` to `true`.
All actions ran while this secret is enabled will show debug events in the [Downloaded Logs](https://help.github.com/en/articles/managing-a-workflow-run#downloading-logs-and-artifacts) and [Web Logs](https://help.github.com/en/articles/managing-a-workflow-run#viewing-logs-to-diagnose-failures). All actions ran while this secret is enabled will show debug events in the [Downloaded Logs](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run#downloading-logs-and-artifacts) and [Web Logs](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/managing-a-workflow-run#viewing-logs-to-diagnose-failures).

2
packages/github/README.md
View File

@ -14,7 +14,7 @@ async function run() {
// This should be a token with access to your repository scoped in as a secret. // This should be a token with access to your repository scoped in as a secret.
// The YML workflow will need to set myToken with the GitHub Secret Token // The YML workflow will need to set myToken with the GitHub Secret Token
// myToken: ${{ secrets.GITHUB_TOKEN }} // myToken: ${{ secrets.GITHUB_TOKEN }}
// https://help.github.com/en/articles/virtual-environments-for-github-actions#github_token-secret // https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token#about-the-github_token-secret
const myToken = core.getInput('myToken'); const myToken = core.getInput('myToken');
const octokit = new github.GitHub(myToken); const octokit = new github.GitHub(myToken);