Skip to content

Commit f398a65

Browse files
committed
fix after review from @henrymercer
1 parent fc374f5 commit f398a65

File tree

7 files changed

+38
-36
lines changed

7 files changed

+38
-36
lines changed

README.md

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -137,41 +137,35 @@ By default, this will override any queries specified in a config file. If you wi
137137

138138
### Configuration via `config` input
139139

140-
141140
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)."
142141

142+
#### Example configuration
143143

144-
145-
- **Complete Configuration**
146-
147-
```yaml
148-
- uses: github/codeql-action/init@v2
149-
with:
150-
languages: ${{ matrix.language }}
151-
config: |
152-
disable-default-queries: true
153-
queries:
154-
- uses: security-extended
155-
- uses: security-and-quality
156-
query-filters:
157-
- include:
158-
tags: /cwe-020/
159-
```
144+
```yaml
145+
- uses: github/codeql-action/init@v2
146+
with:
147+
languages: ${{ matrix.language }}
148+
config: |
149+
disable-default-queries: true
150+
queries:
151+
- uses: security-extended
152+
- uses: security-and-quality
153+
query-filters:
154+
- include:
155+
tags: /cwe-020/
156+
```
160157

161158

162-
- **Actions Variables**
159+
#### Sharing configuration across multiple repositories
163160

164-
You can use actions or environment variables to share configuration across multiple repositories and to modify configuration without needing to edit the workflow file.
161+
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):
165162

166-
```yaml
167-
- uses: github/codeql-action/init@v2
168-
with:
169-
languages: ${{ matrix.language }}
170-
config: ${{ vars.CODEQL_CONF }}
171-
```
172-
173-
174-
where `vars.CODEQL_CONF` references an [Actions configuration variable](https://docs.github.com/en/actions/learn-github-actions/variables#defining-configuration-variables-for-multiple-workflows).
163+
```yaml
164+
- uses: github/codeql-action/init@v2
165+
with:
166+
languages: ${{ matrix.language }}
167+
config: ${{ vars.CODEQL_CONF }}
168+
```
175169

176170
## Troubleshooting
177171

lib/config-utils.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/config-utils.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/config-utils.test.js

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/config-utils.test.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/config-utils.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -925,9 +925,9 @@ test("Queries in workflow file can be added to the set of queries without overri
925925
});
926926
});
927927

928-
test("Queries can be specified in configuration, same as file", async (t) => {
928+
test("Queries can be specified using config input", async (t) => {
929929
return await util.withTmpDir(async (tmpDir) => {
930-
const inputFileContents = `
930+
const configInput = `
931931
name: my config
932932
queries:
933933
- uses: ./foo
@@ -967,7 +967,7 @@ test("Queries can be specified in configuration, same as file", async (t) => {
967967
undefined,
968968
undefined,
969969
undefined,
970-
inputFileContents,
970+
configInput,
971971
false,
972972
false,
973973
"",

src/config-utils.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1708,6 +1708,11 @@ export async function initConfig(
17081708

17091709
// if configInput is set, it takes precedence over configFile
17101710
if (configInput) {
1711+
if (configFile) {
1712+
logger.warning(
1713+
`Both a config file and config input were provided. Ignoring config file.`
1714+
);
1715+
}
17111716
configFile = path.resolve(workspacePath, "user-config-from-action.yml");
17121717
fs.writeFileSync(configFile, configInput);
17131718
logger.debug(`Using config from action input: ${configFile}`);

0 commit comments

Comments
 (0)