Skip to content

Commit

Permalink
Remove output from README
Browse files Browse the repository at this point in the history
As this is an advanced usage it makes more sense to work to getting this included in the documentation instead.
  • Loading branch information
Simon Engledew committed Nov 5, 2020
1 parent c87f302 commit f761241
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 19 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
with:
languages: javascript
config-file: ./.github/codeql/codeql-config.yml
# example from README.md
# confirm steps.init.outputs.codeql-path points to the codeql binary
- name: Print CodeQL Version
run: ${{steps.init.outputs.codeql-path}} version --format=json
- uses: ./analyze
18 changes: 0 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,24 +125,6 @@ By default, this will override any queries specified in a config file. If you wi
queries: +<local-or-remote-query>,<another-query>
```

### Calling CodeQL Directly

The `init` action makes the path to CodeQL available as the output `codeql-path`.

With this you can access the `codeql` binary:

<!-- this example is run via .github/workflows/codeql.yml -->
```yaml
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
id: init
with:
languages: javascript
- name: Print CodeQL Version
run: ${{steps.init.outputs.codeql-path}} version --format=json
```

## Troubleshooting

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

0 comments on commit f761241

Please sign in to comment.