gh-mrva/README.org

• Using MRVA
  • Set up controller repo
  • Use the codeql extension to run MRVA
  • Action logs on Controller Repository
  • Use custom list with target repos in VS Code

Using MRVA

This repository has several additions to illustrate a full MRVA workflow.

Set up controller repo

Following the instructions, start with manually creating the controller repository

  gh repo create mirva-controller --public -d 'Controller for MRVA'

This avoids

  An error occurred while setting up the controller repository: Controller
  repository "hohn/mirva-controller" not found.

Populate the controller repository

  mkdir -p ~/local/mirva-controller && cd ~/local/mirva-controller 
  echo "* mirva-controller" >> README.org
  git init
  git add README.org
  git commit -m "first commit"
  git branch -M master
  git remote add origin git@github.com:hohn/mirva-controller.git
  git push -u origin master

This avoids

  Variant analysis failed because the controller repository hohn/mirva-controller
  does not have a branch 'master'. Please create a 'master' branch by clicking here
  and re-run the variant analysis query.

Use the codeql extension to run MRVA

Following the instructions and running ./FlatBuffersFunc.ql, the entry google/flatbuffers has one 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>google flatbuffers log references

github/codeql-variant-analysis-action

  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

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

Use custom list with target repos in VS Code

The json file is here:

/Users/hohn/Library/Application Support/Code/User/workspaceStorage/bced2e4aa1a5f78ca07cf9e09151b1af/GitHub.vscode-codeql/databases.json

It can be edited in VS Code using the {} button.

It's saved in the workspace, but not in the current git repository.

Here are two snapshots for reference:

  {
    "version": 1,
    "databases": {
      "variantAnalysis": {
        "repositoryLists": [
          {
            "name": "mirva-list",
            "repositories": [
              "google/flatbuffers"
            ]
          }
        ],
        "owners": [],
        "repositories": []
      }
    },
    "selected": {
      "kind": "variantAnalysisSystemDefinedList",
      "listName": "top_10"
    }
  }

or

  {
    "version": 1,
    "databases": {
      "variantAnalysis": {
        "repositoryLists": [
          {
            "name": "mirva-list",
            "repositories": [
              "google/flatbuffers"
            ]
          }
        ],
        "owners": [],
        "repositories": []
      }
    },
    "selected": {
      "kind": "variantAnalysisUserDefinedList",
      "listName": "mirva-list"
    }
  }