diff --git a/README.org b/README.org index 77233b0..d145859 100644 --- a/README.org +++ b/README.org @@ -31,38 +31,38 @@ #+END_SRC ** Use the codeql extension to run MRVA - Following the [[https://codeql.github.com/docs/codeql-for-visual-studio-code/running-codeql-queries-at-scale-with-mrva/#controller-repository][instructions]] and running =./FlatBuffersFunc.ql=, the entry - =google/flatbuffers= has one [[https://github.com/google/flatbuffers/blob/dbce69c63b0f3cee8f6d9521479fd3b087338314/src/binary_annotator.cpp#L25C21-L25C37][result]]. Others have none. + Following the [[https://codeql.github.com/docs/codeql-for-visual-studio-code/running-codeql-queries-at-scale-with-mrva/#controller-repository][instructions]] and running =./FlatBuffersFunc.ql=, the entry + =google/flatbuffers= has one [[https://github.com/google/flatbuffers/blob/dbce69c63b0f3cee8f6d9521479fd3b087338314/src/binary_annotator.cpp#L25C21-L25C37][result]]. Others have none. ** Action logs on Controller Repository - The action logs are on the controller repository at - https://github.com/hohn/mirva-controller/actions. + The action logs are on the controller repository at + https://github.com/hohn/mirva-controller/actions. - The =action>google flatbuffers= log references - : github/codeql-variant-analysis-action - #+BEGIN_SRC yaml - Run actions/checkout@v4 - with: - repository: github/codeql-variant-analysis-action - ref: main - token: *** - ssh-strict: true - persist-credentials: true - clean: true - sparse-checkout-cone-mode: true - fetch-depth: 1 - fetch-tags: false - show-progress: true - lfs: false - submodules: false - set-safe-directory: true - env: - CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT: true - #+END_SRC - This is https://github.com/github/codeql-variant-analysis-action + The =action>google flatbuffers= log references + : github/codeql-variant-analysis-action + #+BEGIN_SRC yaml + Run actions/checkout@v4 + with: + repository: github/codeql-variant-analysis-action + ref: main + token: *** + ssh-strict: true + persist-credentials: true + clean: true + sparse-checkout-cone-mode: true + fetch-depth: 1 + fetch-tags: false + show-progress: true + lfs: false + submodules: false + set-safe-directory: true + env: + CODEQL_ENABLE_EXPERIMENTAL_FEATURES_SWIFT: true + #+END_SRC + This is https://github.com/github/codeql-variant-analysis-action - The workflow producing the logs: - https://github.com/github/codeql-variant-analysis-action/blob/main/variant-analysis-workflow.yml + The workflow producing the logs: + https://github.com/github/codeql-variant-analysis-action/blob/main/variant-analysis-workflow.yml @@ -76,52 +76,92 @@ It's saved in the workspace, but not in the current git repository. Here are two snapshots for reference: - #+begin_src javascript - { - "version": 1, - "databases": { - "variantAnalysis": { - "repositoryLists": [ - { - "name": "mirva-list", - "repositories": [ - "google/flatbuffers" - ] - } - ], - "owners": [], - "repositories": [] - } - }, - "selected": { - "kind": "variantAnalysisSystemDefinedList", - "listName": "top_10" - } - } - #+end_src - or - #+begin_src javascript - { - "version": 1, - "databases": { - "variantAnalysis": { - "repositoryLists": [ - { - "name": "mirva-list", - "repositories": [ - "google/flatbuffers" - ] - } - ], - "owners": [], - "repositories": [] - } - }, - "selected": { - "kind": "variantAnalysisUserDefinedList", - "listName": "mirva-list" - } - } - #+end_src + #+begin_src javascript + { + "version": 1, + "databases": { + "variantAnalysis": { + "repositoryLists": [ + { + "name": "mirva-list", + "repositories": [ + "google/flatbuffers" + ] + } + ], + "owners": [], + "repositories": [] + } + }, + "selected": { + "kind": "variantAnalysisSystemDefinedList", + "listName": "top_10" + } + } + #+end_src + or + #+begin_src javascript + { + "version": 1, + "databases": { + "variantAnalysis": { + "repositoryLists": [ + { + "name": "mirva-list", + "repositories": [ + "google/flatbuffers" + ] + } + ], + "owners": [], + "repositories": [] + } + }, + "selected": { + "kind": "variantAnalysisUserDefinedList", + "listName": "mirva-list" + } + } + #+end_src + +** Run MRVA from command line + 1. Set up the configuration + #+BEGIN_SRC sh + cd ~/local/gh-mrva + + cat > ~/.config/gh-mrva/config.yml <