Merge remote-tracking branch 'origin/master' into data-breakpoints

Author: puremourning

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -23,10 +23,10 @@ body:
   - type: dropdown
     id: issue-works-in-vim
     attributes:
-      label: Works in vim?
+      label: Is it reproducible in vim?
       description: If you are using Neovim, does the issue reproduce in Vim?
       options:
-        - Reproducable in Vim
+        - Reproducible in Vim
         - Only broken in Neovim
     validations:
       required: true
@@ -49,8 +49,8 @@ body:
       label: Sample project works?
       description: Try one of the sample projects in `support/test` for your file type. Does that work? If not, use the sample project for crating your reproduction case.
       options:
-        - Not reproducable with sample project
-        - Reproducable with sample project
+        - Not reproducible with sample project
+        - Reproducible with sample project
         - No sample project for this filetype
     validations:
       required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -3,9 +3,6 @@ contact_links:
   - name: Questions and support
     url: 'https://matrix.to/#/#vimspector_Lobby:gitter.im'
     about: Please ask and answer questions here.
-  - name: Discussions
-    url: https://github.com/puremourning/vimspector/discussions
-    about: Please post questions and useful hints here
   - name: Support for additional languages
     url: https://github.com/puremourning/vimspector/wiki/languages
     about: Please see here for information on support for additional languages

.github/workflows/build.yaml

@@ -87,19 +87,8 @@ jobs:
         name: 'test-logs-${{ runner.os }}-${{ matrix.runtime }}'
         path: 'tests/logs/**/*'
 
-    - name: 'Package'
-      if: matrix.runtime == 'vim'
-      run: ./make_package linux ${{ github.run_id }}
-
     # TODO: test the tarball
 
-    - name: "Upload package"
-      if: matrix.runtime == 'vim'
-      uses: actions/upload-artifact@v2
-      with:
-        name: 'package-linux'
-        path: 'package/linux-${{ github.run_id }}.tar.gz'
-
     # - name: Start SSH session if failed
     #   uses: luchihoratiu/debug-via-ssh@main
     #   if: failure()
@@ -114,22 +103,26 @@ jobs:
       matrix:
         runtime:
           - vim
-          - nvim
+          # - nvim ; MacOS in GHA is so slow, this seems to cause lots of
+          # flakiness for neovim and I have like 0 patience with trying to
+          # understand why.
     steps:
     - uses: actions/checkout@v3
 
     - run: |
         brew update-reset
         brew doctor || true
         brew cleanup || true
-        for p in vim go tcl-tk llvm lua luajit love neovim; do
+        for p in vim go tcl-tk llvm lua luajit love neovim coreutils; do
           brew install $p || brew outdated $p || brew upgrade $p
         done
         brew reinstall icu4c
         brew link --overwrite python
         brew link --overwrite vim
         brew link --overwrite go
-        pip3 install --user neovim
+        # latest neovim doesn't work on python 3.12
+        # https://github.com/neovim/pynvim/issues/538
+        pip3 install --user 'pynvim @ git+https://github.com/neovim/pynvim'
       name: 'Install vim and deps'
 
     - name: 'Install requirements'
@@ -176,66 +169,11 @@ jobs:
         name: 'test-logs-${{ runner.os }}-${{ matrix.runtime }}'
         path: 'tests/logs/**/*'
 
-    - name: 'Package'
-      if: matrix.runtime == 'vim'
-      run: ./make_package macos ${{ github.run_id }}
-
     # TODO: test the tarball
 
-    - name: "Upload package"
-      if: matrix.runtime == 'vim'
-      uses: actions/upload-artifact@v2
-      with:
-        name: 'package-macos'
-        path: 'package/macos-${{ github.run_id }}.tar.gz'
-
     # - name: Start SSH session if failed
     #  uses: luchihoratiu/debug-via-ssh@main
     #  if: failure() || cancelled()
     #  with:
     #    NGROK_AUTH_TOKEN: ${{ secrets.NGROK_AUTH_TOKEN }}
     #    SSH_PASS: ${{ secrets.SSH_PASS }}
-
-  PublishRelease:
-    runs-on: 'ubuntu-20.04'
-    needs:
-      - Linux
-      - MacOS
-    if: github.ref == 'refs/heads/master'
-    steps:
-    - name: 'Download artifacts'
-      id: download_artifacts
-      uses: actions/download-artifact@v2
-
-    - name: 'Create Release'
-      id: create_release
-      uses: actions/create-release@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        tag_name: ${{ github.run_id }}
-        release_name: Build ${{ github.run_id }}
-        draft: false
-        prerelease: true
-
-    - name: 'Upload Linux Package'
-      id: upload-release-asset-linux
-      uses: actions/upload-release-asset@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ${{ steps.download_artifacts.outputs.download-path }}/package-linux/linux-${{ github.run_id }}.tar.gz
-        asset_name: vimspector-linux-${{ github.run_id }}.tar.gz
-        asset_content_type: application/gzip
-
-    - name: 'Upload MacOS Package'
-      id: upload-release-asset-macos
-      uses: actions/upload-release-asset@v1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: ${{ steps.download_artifacts.outputs.download-path }}/package-macos/macos-${{ github.run_id }}.tar.gz
-        asset_name: vimspector-macos-${{ github.run_id }}.tar.gz
-        asset_content_type: application/gzip

.mergify.yml

@@ -9,7 +9,7 @@ queue_rules:
       - status-success=Linux (vim)
       - status-success=Linux (nvim)
       - status-success=MacOS (vim)
-      - status-success=MacOS (nvim)
+      #- status-success=MacOS (nvim)
 
 pull_request_rules:
   - name: Merge owner PR when all checks passed
@@ -26,7 +26,7 @@ pull_request_rules:
       - status-success=Linux (vim)
       - status-success=Linux (nvim)
       - status-success=MacOS (vim)
-      - status-success=MacOS (nvim)
+      #- status-success=MacOS (nvim)
     actions: &merge-actions
       queue:
         method: merge
@@ -61,7 +61,7 @@ pull_request_rules:
       - status-success=Linux (vim)
       - status-success=Linux (nvim)
       - status-success=MacOS (vim)
-      - status-success=MacOS (nvim)
+      #- status-success=MacOS (nvim)
     actions:
       <<: *merge-actions
       comment:

CONTRIBUTING.md

@@ -40,6 +40,23 @@ information when something goes wrong that's not a clear Vim traceback.
 If you just want to see the Vimspector log file, use `:VimspectorToggleLog`,
 which will tail it in a little window (doesn't work on Windows).
 
+## Discussions
+
+GitHub discussions are not for *bug reports* or *feature requests* - please
+use GitHub Issues for that.
+
+If you're not sure if your issue is a bug, feature, or just configuration
+error, then feel free to use the Q&A Discussion and/or the Matrix channel
+to check. Don't be offended if the response is that it's a bug or feature
+requests requiring raising a full Issue. 
+
+This is mainly for project management purposes, as:
+
+* the Issues template contains a lot of data that maintainers require to
+  diagnose them, and
+* feature requests can be put in Projects and tracked; requests in
+  Discussions are easily forgotten.
+
 ## Issues
 
 The GitHub issue tracker is for *bug reports* and *features requests* for the
@@ -156,6 +173,19 @@ When contributing pull requests, I ask that:
 
 ### Running the tests locally
 
+Requirements for running the tests:
+
+* Linux or macOS
+* Supported Vim or Neovim version (ideally both)
+* acsiinema instaled (`pip3 install --user asciinema`)
+* `timeout` installed (on macOS: `brew install coreutils`)
+* various other dependencies for the individual debuggers.
+
+The simplest way to run the tests is using the container image, as all
+dependencies are there for you. If you decide not to, then the best way to work
+out what's required is to look at either the `Dockerfile` (for Linux) or the
+`.github/workflows/build.yaml` (for macOS).
+
 There are 2 ways:
 
 1. In the docker container. The CI tests for linux run in a container, so as to