Merge branch 'mrcjkb:master' into master

.github/DISCUSSION_TEMPLATE/q-a.yml

@@ -0,0 +1,104 @@
+---
+labels: [Question]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in rustaceanvim 🦀
+        Please follow these instructions, fill every question, and do every step. 🙏
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Checked other resources
+      description: Please confirm and check all the following options.
+      options:
+        - label: This is not a bug report or feature request (Please use [issues](https://github.com/mrcjkb/rustaceanvim/issues/new/choose) for those).
+          required: true
+        - label: This is a question about rustaceanvim, not rust-analyzer or Neovim.
+          required: true
+        - label: This is [not a question about autocompletion](https://github.com/mrcjkb/rustaceanvim?tab=readme-ov-file#im-having-issues-with-autocompletion).
+          required: true
+        - label: I have read the README.
+          required: true
+        - label: I have read the [FAQ](https://github.com/mrcjkb/rustaceanvim?tab=readme-ov-file#left_speech_bubble-faq).
+          required: true
+        - label: I have searched for a solution using `:h rustaceanvim`.
+          required: true
+        - label: I have searched [existing discussions](https://github.com/mrcjkb/rustaceanvim/discussions).
+          required: true
+        - label: I have searched the existing issues/discussions of other plugins related to this question (if applicable).
+          required: false
+        - label: I have searched the [existing rust-analyzer discussions](https://github.com/rust-lang/rust-analyzer/discussions) (if applicable).
+          required: false
+        - label: I have added a very descriptive title to this question.
+          required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        What is the problem, question, or error?
+
+        Write a short description explaining what you are doing, what you expect to happen, and what is currently happening.
+      placeholder: |
+        * I'm trying to use the `rustaceanvim` plugin to do X.
+        * I expect to see Y.
+        * Instead, it does Z.
+    validations:
+      required: true
+  - type: textarea
+    id: example
+    attributes:
+      label: Example Code
+      description: |
+        Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
+        You can use [the minimal config as a template](https://github.com/mrcjkb/rustaceanvim/blob/master/troubleshooting/minimal.lua).
+        
+        If a maintainer can copy it, run it, and see it right away, there's a much higher chance that you'll be able to get help.
+        
+        > [!IMPORTANT]
+        > 
+        > - Reduce your code to the minimum required to reproduce the issue if possible. This makes it much easier for others to help you.
+        > - Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
+
+      placeholder: |
+        vim.env.LAZY_STDPATH = '.repro'
+        load(vim.fn.system('curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua'))()
+
+        require('lazy.minit').repro {
+          spec = {
+            {
+              'mrcjkb/rustaceanvim',
+              version = '^5',
+              init = function()
+                -- Configure rustaceanvim here
+                vim.g.rustaceanvim = {}
+              end,
+              lazy = false,
+            },
+          },
+        }
+        -- do anything else you need to do to reproduce the issue
+      render: lua
+    validations:
+      required: true 
+  - type: input
+    attributes:
+      label: "Neovim version (nvim -v)"
+      placeholder: "v0.10.1"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: "Operating system/version"
+      placeholder: "NixOS 24.05"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Output of :checkhealth rustaceanvim"
+      render: "console"
+      placeholder: |
+        Please paste the output here, as it may contain important information for debugging.
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -22,16 +22,20 @@ body:
           required: false
         - label: I can reproduce the issue with stable Neovim (not a distribution or nightly) and the [minimal config](https://github.com/mrcjkb/rustaceanvim/blob/master/troubleshooting/minimal.lua).
           required: true
+        - label: This is an issue about rustaceanvim, not rust-analyzer or Neovim.
+          required: true
+        - label: This is [not an issue with autocompletion](https://github.com/mrcjkb/rustaceanvim?tab=readme-ov-file#im-having-issues-with-autocompletion).
+          required: true
   - type: input
     attributes:
       label: "Neovim version (nvim -v)"
-      placeholder: "v0.9.5"
+      placeholder: "v0.10.1"
     validations:
       required: true
   - type: input
     attributes:
       label: "Operating system/version"
-      placeholder: "NixOS 23.11"
+      placeholder: "NixOS 24.05"
     validations:
       required: true
   - type: textarea
@@ -53,6 +57,7 @@ body:
         > - To rule out another plugin causing the issue, please start with a [minimal config](https://github.com/mrcjkb/rustaceanvim/blob/master/troubleshooting/minimal.lua).
         > - Please refer to the readme's [troubleshooting guide](https://github.com/mrcjkb/rustaceanvim?tab=readme-ov-file#stethoscope-troubleshooting).
         > - Please provide exact (repeatable) steps, including project initialization (if applicable).
+        > - Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
       placeholder: |
         mkdir -p /tmp/minimal
         NVIM_DATA_MINIMAL=/tmp/minimal NVIM_APP_NAME="nvim-minimal" -u minimal.lua
@@ -78,6 +83,12 @@ body:
       label: "The minimal config used to reproduce this issue."
       description: |
         Run with `nvim -u minimal.lua`
+
+        > [!IMPORTANT]
+        > 
+        > - Reduce your code to the minimum required to reproduce.
+        > - Avoid screenshots when possible, as they are hard to read and (more importantly) don't allow others to copy-and-paste your code.
+
       placeholder: |
         vim.env.LAZY_STDPATH = '.repro'
         load(vim.fn.system('curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua'))()
@@ -86,7 +97,7 @@ body:
           spec = {
             {
               'mrcjkb/rustaceanvim',
-              version = '^4',
+              version = '^5',
               init = function()
                 -- Configure rustaceanvim here
                 vim.g.rustaceanvim = {}

.github/workflows/release.yml → .github/workflows/luarocks.yml

@@ -1,8 +1,12 @@
-name: "Release"
+---
+name: "Push to LuaRocks"
 on:
   push:
     tags:
       - "*"
+  release:
+    types:
+      - created
   pull_request:
 
 jobs:
@@ -12,23 +16,17 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Fail if changelog entry does not exist
-        if: startsWith(github.ref, 'refs/tags/')
-        run: grep -q "${{ github.ref_name }}" CHANGELOG.md
+        with:
+          fetch-depth: 0 # Required to count the commits
+      - name: Get Version
+        run: echo "LUAROCKS_VERSION=$(git describe --abbrev=0 --tags)" >> $GITHUB_ENV
       - name: LuaRocks Upload
-        uses: nvim-neorocks/luarocks-tag-release@v5
+        uses: nvim-neorocks/luarocks-tag-release@v7
         env:
           LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
         with:
-          test_interpreters: ""
+          version: ${{ env.LUAROCKS_VERSION }}
           detailed_description: |
             This plugin automatically configures the rust-analyzer builtin LSP client
             and integrates with other Rust tools. See the README's #features section
             for more info.
-      - name: GitHub Release
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: ncipollo/release-action@v1
-        with:
-          bodyFile: "CHANGELOG.md"
-          allowUpdates: true
-

.github/workflows/release-please.yml

@@ -0,0 +1,22 @@
+---
+permissions:
+  contents: write
+  pull-requests: write
+
+name: Release Please
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          release-type: simple
+          token: ${{ secrets.PAT }}

.github/workflows/review-checklist.yml

@@ -49,6 +49,5 @@ jobs:
               - [ ] Tests have been added.
               - [ ] Tested manually (Steps to reproduce in PR description).
             - [ ] Updated documentation.
-            - [ ] Updated [CHANGELOG.md](https://github.com/mrcjkb/rustaceanvim/blob/master/CHANGELOG.md)
             `,
             })

.gitignore

@@ -1,4 +1,5 @@
-result/
+result
+result-*
 .direnv
 .luarc.json
 .repro