Skip to content

Commit 8ca5570

Browse files
authored
Merge pull request #1666 from github/aeisenberg/readme-update
Add link to changenote for custom config
2 parents d2f6dfd + b1b3d00 commit 8ca5570

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## [UNRELEASED]
44

5-
- 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)
5+
- 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)
66

77
## 2.3.2 - 27 Apr 2023
88

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ By default, this will override any queries specified in a config file. If you wi
137137

138138
### Configuration via `config` input
139139

140-
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)."
140+
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)."
141141

142142
#### Example configuration
143143

@@ -157,7 +157,7 @@ You can alternatively configure CodeQL using the `config` input to the `init` Ac
157157

158158

159159
#### Sharing configuration across multiple repositories
160-
160+
161161
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):
162162

163163
```yaml
@@ -170,4 +170,3 @@ You can use Actions or environment variables to share configuration across multi
170170
## Troubleshooting
171171

172172
Read about [troubleshooting code scanning](https://help.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-code-scanning).
173-

0 commit comments

Comments
 (0)