From f76124122e73adfc02a4c9b4daf413fb7bdf235f Mon Sep 17 00:00:00 2001 From: Simon Engledew Date: Thu, 5 Nov 2020 08:31:32 +0000 Subject: [PATCH] Remove output from README As this is an advanced usage it makes more sense to work to getting this included in the documentation instead. --- .github/workflows/codeql.yml | 2 +- README.md | 18 ------------------ 2 files changed, 1 insertion(+), 19 deletions(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 5777edbc7..88ff7a0a0 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -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 diff --git a/README.md b/README.md index e5bc673ff..6f35ee780 100644 --- a/README.md +++ b/README.md @@ -125,24 +125,6 @@ By default, this will override any queries specified in a config file. If you wi queries: +, ``` -### 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: - - -```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).