From 727df79846cc1bc80b66158310eaea67e766d7c5 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Thu, 4 May 2023 07:31:20 -0400 Subject: [PATCH 1/3] Correct links in definitions (#36834) --- ...authenticating-to-the-rest-api-with-an-oauth-app.md | 6 +++--- .../using-ssh-agent-forwarding.md | 6 +++--- content/rest/guides/best-practices-for-integrators.md | 2 +- content/rest/guides/delivering-deployments.md | 10 +++++----- content/rest/guides/working-with-comments.md | 8 ++++---- content/webhooks-and-events/webhooks/about-webhooks.md | 4 ++-- .../webhooks-and-events/webhooks/creating-webhooks.md | 6 +++--- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/content/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md b/content/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md index 6c85fb3b2e..f3993f9822 100644 --- a/content/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md +++ b/content/apps/oauth-apps/building-oauth-apps/authenticating-to-the-rest-api-with-an-oauth-app.md @@ -359,13 +359,13 @@ the same callback URL, we've got to do a little bit of wonkiness to make it work Also, if we had never authorized this application to access our {% data variables.product.product_name %} data, we would've seen the same confirmation dialog from earlier pop-up and warn us. -[webflow]: /apps/building-oauth-apps/authorizing-oauth-apps/ +[webflow]: /apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps [Sinatra]: http://www.sinatrarb.com/ [about env vars]: http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables [Sinatra guide]: https://github.com/sinatra/sinatra-book/blob/master/book/Introduction.markdown#hello-world-application [REST Client]: https://github.com/archiloque/rest-client -[libraries]: /libraries/ -[oauth scopes]: /apps/building-oauth-apps/understanding-scopes-for-oauth-apps/ +[libraries]: /rest/overview/libraries +[oauth scopes]: /apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/basics-of-authentication [new oauth app]: https://github.com/settings/applications/new [app settings]: https://github.com/settings/developers diff --git a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md index f22852b591..ca84dec2cb 100644 --- a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md +++ b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md @@ -164,6 +164,6 @@ For MacOS versions prior to Monterey (12.0), use `-K` instead of `--apple-use-ke {% endtip %} [tech-tips]: http://www.unixwiz.net/techtips/ssh-agent-forwarding.html -[generating-keys]: /articles/generating-ssh-keys -[ssh-passphrases]: /ssh-key-passphrases/ -[autolaunch-ssh-agent]: /github/authenticating-to-github/working-with-ssh-key-passphrases#auto-launching-ssh-agent-on-git-for-windows +[generating-keys]: /authentication/connecting-to-github-with-ssh +[ssh-passphrases]: /authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases +[autolaunch-ssh-agent]: /authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases#auto-launching-ssh-agent-on-git-for-windows diff --git a/content/rest/guides/best-practices-for-integrators.md b/content/rest/guides/best-practices-for-integrators.md index 35fdf36900..6d67abbd59 100644 --- a/content/rest/guides/best-practices-for-integrators.md +++ b/content/rest/guides/best-practices-for-integrators.md @@ -170,4 +170,4 @@ Rather than ignore repeated `4xx` and `5xx` status codes, you should ensure that Intentionally ignoring repeated validation errors may result in the suspension of your app for abuse. -[event-types]: /webhooks/event-payloads +[event-types]: /webhooks-and-events/webhooks/webhook-events-and-payloads diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md index 7dfa9f2232..ec8270e164 100644 --- a/content/rest/guides/delivering-deployments.md +++ b/content/rest/guides/delivering-deployments.md @@ -189,15 +189,15 @@ server we've built above: That's it! You don't need to build your own deployment setup to use this example. You can always rely on [GitHub integrations][integrations]. -[deploy API]: /rest/reference/repos#deployments -[status API]: /guides/building-a-ci-server +[deploy API]: /rest/repos#deployments +[status API]: /rest/guides/building-a-ci-server [ngrok]: https://ngrok.com/ -[using ngrok]: /webhooks/configuring/#using-ngrok +[using ngrok]: /webhooks-and-events/webhooks/configuring-your-server-to-receive-payloads#using-ngrok [platform samples]: https://github.com/github/platform-samples/tree/master/api/ruby/delivering-deployments [Sinatra]: http://www.sinatrarb.com/ -[webhook]: /webhooks/ +[webhook]: /webhooks-and-events/webhooks/about-webhooks [octokit.rb]: https://github.com/octokit/octokit.rb -[access token]: /articles/creating-an-access-token-for-command-line-use +[access token]: /authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token [travis api]: https://api.travis-ci.com/docs/ [janky]: https://github.com/github/janky [heaven]: https://github.com/atmos/heaven diff --git a/content/rest/guides/working-with-comments.md b/content/rest/guides/working-with-comments.md index dbc5c0a370..fcc97851b2 100644 --- a/content/rest/guides/working-with-comments.md +++ b/content/rest/guides/working-with-comments.md @@ -122,8 +122,8 @@ on the entire commit. [commit comment]: https://github.com/octocat/Spoon-Knife/commit/cbc28e7c8caee26febc8c013b0adfb97a4edd96e#commitcomment-4049848 [sample PR]: https://github.com/octocat/Spoon-Knife/pull/1176 [platform-samples]: https://github.com/github/platform-samples/tree/master/api/ruby/working-with-comments -[issues]: /rest/reference/issues#comments -[personal token]: /articles/creating-an-access-token-for-command-line-use +[issues]: /rest/issues#comments +[personal token]: /authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token [octokit.rb]: https://github.com/octokit/octokit.rb -[PR Review API]: /rest/reference/pulls#comments -[commit comment API]: /rest/reference/commits#get-a-commit-comment +[PR Review API]: /rest/pulls#comments +[commit comment API]: /rest/commits#get-a-commit-comment diff --git a/content/webhooks-and-events/webhooks/about-webhooks.md b/content/webhooks-and-events/webhooks/about-webhooks.md index 4c2aab6f9c..cd667650f5 100644 --- a/content/webhooks-and-events/webhooks/about-webhooks.md +++ b/content/webhooks-and-events/webhooks/about-webhooks.md @@ -36,5 +36,5 @@ For a complete list of available webhook events and their payloads, see "[AUTOTI For more information about the `ping` event webhook payload, see the [`ping`](/webhooks-and-events/webhooks/webhook-events-and-payloads#ping) event. -[org-hooks]: /rest/reference/orgs#webhooks/ -[repo-hooks]: /rest/reference/repos#webhooks +[org-hooks]: /rest/orgs#webhooks/ +[repo-hooks]: /rest/repos#webhooks diff --git a/content/webhooks-and-events/webhooks/creating-webhooks.md b/content/webhooks-and-events/webhooks/creating-webhooks.md index a97fab251d..acf6039526 100644 --- a/content/webhooks-and-events/webhooks/creating-webhooks.md +++ b/content/webhooks-and-events/webhooks/creating-webhooks.md @@ -94,6 +94,6 @@ Now that you've created the webhook, it's time to set up our local server to tes To configure a webhook for all events, use the wildcard (`*`) character to specify the webhook events. When you add the wildcard event, we'll replace any existing events you have configured with the wildcard event and send you payloads for all supported events. You'll also automatically get any new events we might add in the future. -[webhooks-overview]: /webhooks/ -[webhook-api]: /rest/reference/repos#hooks -[hooks-api]: /webhooks/#events +[webhooks-overview]: /webhooks-and-events/webhooks/about-webhooks +[webhook-api]: /rest/repos#hooks +[hooks-api]: /webhooks-and-events/webhooks/about-webhooks#events From b9c1af2ca3fb512a0848bb5e5045910168d4c385 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Thu, 4 May 2023 12:36:34 +0100 Subject: [PATCH 2/3] Codespaces: Remove reference to the CODESPACES_PREBUILD_TOKEN secret from the prebuild article (#36813) --- .../prebuilding-your-codespaces/configuring-prebuilds.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 71a2f0726a..ee4fa9dd1c 100644 --- a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -115,9 +115,7 @@ For information about editing and deleting prebuild configurations, see "[AUTOTI ## Configuring environment variables -To allow the prebuild process to access environment variables required to create your development environment, you can set these either as {% data variables.product.prodname_codespaces %} repository secrets or as {% data variables.product.prodname_codespaces %} organization secrets. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-a-repository)" and "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-an-organization)." - -Secrets that you create in this way will be accessible by anyone who creates a codespace from this repository. If you do not want this, you can alternatively set the `CODESPACES_PREBUILD_TOKEN` secret. The `CODESPACES_PREBUILD_TOKEN` secret is only used for prebuilding and its value is not accessible in users' codespaces. +To allow the prebuild process to access environment variables required to create your development environment, you can set these either as {% data variables.product.prodname_codespaces %} repository secrets or as {% data variables.product.prodname_codespaces %} organization secrets. Secrets that you create in this way will be accessible by anyone who creates a codespace from this repository. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-a-repository)" and "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-an-organization)." Prebuilds cannot use any user-level secrets while building your environment, because these are not available until after the codespace has been created. From cf836f5af476059a39090a6248d693a4ead068f2 Mon Sep 17 00:00:00 2001 From: docubot <67483024+docubot@users.noreply.github.com> Date: Thu, 4 May 2023 04:50:17 -0700 Subject: [PATCH 3/3] Update CodeQL CLI manual (#36809) Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> --- .../codeql-cli/codeql-cli-manual/database-create.md | 10 +++++----- .../codeql-cli-manual/database-index-files.md | 4 ++-- .../codeql-cli/codeql-cli-manual/database-init.md | 12 ++++++------ .../codeql-cli-manual/database-trace-command.md | 6 +++--- .../codeql-cli/codeql-cli-manual/dataset-check.md | 2 +- .../codeql-cli-manual/generate-log-summary.md | 2 +- .../codeql-cli/codeql-cli-manual/test-run.md | 13 +++++++++++-- 7 files changed, 29 insertions(+), 20 deletions(-) diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md index 89a79292d6..e90eaacedf 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md @@ -79,10 +79,10 @@ Use [codeql resolve languages](/code-security/codeql-cli/codeql-cli-manual/resol When the `--db-cluster` option is given, this can appear multiple times, or the value can be a comma-separated list of languages. -If this option is omitted, and the source root being analyzed is a +If this option is omitted, and the source root being analysed is a checkout of a GitHub repository, the CodeQL CLI will make a call to the GitHub API to attempt to automatically determine what languages to -analyze. Note that to be able to do this, a GitHub PAT token must be +analyse. Note that to be able to do this, a GitHub PAT token must be supplied either in the environment variable GITHUB\_TOKEN or via standard input using the `--github-auth-stdin` option. @@ -250,7 +250,7 @@ produce all necessary data directly. #### `--extra-tracing-config=` \[Advanced] The path to a tracer configuration file. It may be used to -modify the behavior of the build tracer. It may be used to pick out +modify the behaviour of the build tracer. It may be used to pick out compiler processes that run as part of the build command, and trigger the execution of other tools. The extractors will provide default tracer configuration files that should work in most situations. @@ -286,7 +286,7 @@ be any string that does not contain a newline. You can use this command-line option repeatedly to set multiple extractor options. If you provide multiple values for the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed after extractor options @@ -312,7 +312,7 @@ string and array options are map entries with string and array values. Extractor option bundle files are read in the order they are specified. If different extractor option bundle files specify the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed before extractor options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md b/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md index 580a69ec72..452b20514d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md @@ -94,7 +94,7 @@ be any string that does not contain a newline. You can use this command-line option repeatedly to set multiple extractor options. If you provide multiple values for the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed after extractor options @@ -120,7 +120,7 @@ string and array options are map entries with string and array values. Extractor option bundle files are read in the order they are specified. If different extractor option bundle files specify the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed before extractor options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md index 40a1236075..25753a33ea 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md @@ -92,10 +92,10 @@ Use [codeql resolve languages](/code-security/codeql-cli/codeql-cli-manual/resol When the `--db-cluster` option is given, this can appear multiple times, or the value can be a comma-separated list of languages. -If this option is omitted, and the source root being analyzed is a +If this option is omitted, and the source root being analysed is a checkout of a GitHub repository, the CodeQL CLI will make a call to the GitHub API to attempt to automatically determine what languages to -analyze. Note that to be able to do this, a GitHub PAT token must be +analyse. Note that to be able to do this, a GitHub PAT token must be supplied either in the environment variable GITHUB\_TOKEN or via standard input using the `--github-auth-stdin` option. @@ -183,7 +183,7 @@ will be used. \[Windows only] When initializing tracing, inject the tracer this many parents above the current process, with 0 corresponding to the process -that is invoking the CodeQL CLI. The CLI's default behavior if no +that is invoking the CodeQL CLI. The CLI's default behaviour if no arguments are passed is to inject into the parent of the calling process. @@ -197,7 +197,7 @@ produce all necessary data directly. #### `--extra-tracing-config=` \[Advanced] The path to a tracer configuration file. It may be used to -modify the behavior of the build tracer. It may be used to pick out +modify the behaviour of the build tracer. It may be used to pick out compiler processes that run as part of the build command, and trigger the execution of other tools. The extractors will provide default tracer configuration files that should work in most situations. @@ -216,7 +216,7 @@ be any string that does not contain a newline. You can use this command-line option repeatedly to set multiple extractor options. If you provide multiple values for the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed after extractor options @@ -242,7 +242,7 @@ string and array options are map entries with string and array values. Extractor option bundle files are read in the order they are specified. If different extractor option bundle files specify the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed before extractor options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md b/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md index 8e89245ff0..d16a0b2225 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md @@ -88,7 +88,7 @@ produce all necessary data directly. #### `--extra-tracing-config=` \[Advanced] The path to a tracer configuration file. It may be used to -modify the behavior of the build tracer. It may be used to pick out +modify the behaviour of the build tracer. It may be used to pick out compiler processes that run as part of the build command, and trigger the execution of other tools. The extractors will provide default tracer configuration files that should work in most situations. @@ -129,7 +129,7 @@ be any string that does not contain a newline. You can use this command-line option repeatedly to set multiple extractor options. If you provide multiple values for the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed after extractor options @@ -155,7 +155,7 @@ string and array options are map entries with string and array values. Extractor option bundle files are read in the order they are specified. If different extractor option bundle files specify the same extractor -option, the behavior depends on the type that the extractor option +option, the behaviour depends on the type that the extractor option expects. String options will use the last value provided. Array options will use all the values provided, in order. Extractor options specified using this command-line option are processed before extractor options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md index a1e64ac9a3..5a5d74114f 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md @@ -63,7 +63,7 @@ Select output format. Possible choices: \[Advanced] Expend extra effort to compute precise locations for inconsistencies. This will take more time, but may make it easier to -debug extractor behavior. +debug extractor behaviour. #### `--max-resolve-depth=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md b/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md index bebadf2af4..512977ff06 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md @@ -47,7 +47,7 @@ event logs directly. #### `` -Path to the location to output the summarized log file to. If this +Path to the location to output the summarised log file to. If this omitted, then the summary will be output to stdout. #### `--minify-output` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md b/content/code-security/codeql-cli/codeql-cli-manual/test-run.md index 584610149b..6d75176660 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/test-run.md @@ -53,9 +53,18 @@ Select output format. Possible choices: `text` *(default)*: A human-readable textual rendering. -`json`: A streamed JSON array of objects. +`json`: A streamed JSON array of test result objects. -`jsonz`: A stream of zero-terminated JSON objects. +`betterjson`: A streamed JSON array of event objects. + +`jsonz`: A stream of zero-terminated JSON test result objects. + +`betterjsonz`: A stream of zero-terminated JSON event objects. + +For the `betterjson` and `betterjsonz` formats, each event has a `type` +property specifying the type of the event. New event types may be added +in the future, so consumers should ignore any event with an unrecognized +`kind` property. #### `--[no-]keep-databases`