From b1b3d00b6278f6319c71d073ce785132634bdd95 Mon Sep 17 00:00:00 2001 From: Andrew Eisenberg Date: Mon, 1 May 2023 11:01:27 -0700 Subject: [PATCH] Add link to changenote for custom config Also, use a better link in the readme. --- CHANGELOG.md | 2 +- README.md | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 030a97c9a4..d91b5c513d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## [UNRELEASED] -- You can now configure CodeQL within your code scanning workflow by passing a `config` input to the `init` Action. [#1590](https://github.com/github/codeql-action/pull/1590) +- You can now configure CodeQL within your code scanning workflow by passing a `config` input to the `init` Action. See [Using a custom configuration file](https://aka.ms/code-scanning-docs/config-file) for more information about configuring code scanning. [#1590](https://github.com/github/codeql-action/pull/1590) ## 2.3.2 - 27 Apr 2023 diff --git a/README.md b/README.md index ae85f42c21..7887e68feb 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ By default, this will override any queries specified in a config file. If you wi ### Configuration via `config` input -You can alternatively configure CodeQL using the `config` input to the `init` Action. The value of this input must be a YAML string that follows the configuration file format documented at "[Using a custom configuration file](https://help.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#using-a-custom-configuration-file)." +You can alternatively configure CodeQL using the `config` input to the `init` Action. The value of this input must be a YAML string that follows the configuration file format documented at "[Using a custom configuration file](https://aka.ms/code-scanning-docs/config-file)." #### Example configuration @@ -157,7 +157,7 @@ You can alternatively configure CodeQL using the `config` input to the `init` Ac #### Sharing configuration across multiple repositories - + You can use Actions or environment variables to share configuration across multiple repositories and to modify configuration without needing to edit the workflow file. In the following example, `vars.CODEQL_CONF` is an [Actions configuration variable](https://docs.github.com/en/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows): ```yaml @@ -170,4 +170,3 @@ You can use Actions or environment variables to share configuration across multi ## Troubleshooting Read about [troubleshooting code scanning](https://help.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning). -