Feat: Upload Files (#59)
This MR adds the ability to add files to comments, notes, replys, and MR descriptions via a picker. The file will get uploaded to Gitlab and the filepath will be automatically added into the current popup buffer at the current line. You can then save the changes with the normal save functionality.
This commit is contained in:
committed by
GitHub
parent
45329f4d69
commit
4e473dab7e
17
README.md
17
README.md
@@ -15,7 +15,7 @@ https://github.com/harrisoncramer/gitlab.nvim/assets/32515581/ab5a8597-32fa-4a28
|
||||
|
||||
## Requirements
|
||||
|
||||
- <a href="https://go.dev/">Go >= v1.19</a>
|
||||
- <a href="https://go.dev/">Go</a> >= v1.19
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -87,6 +87,7 @@ require("gitlab").setup({
|
||||
port = 21036, -- The port of the Go server, which runs in the background
|
||||
log_path = vim.fn.stdpath("cache") .. "/gitlab.nvim.log", -- Log path for the Go server
|
||||
reviewer = "delta", -- The reviewer type ("delta" or "diffview")
|
||||
attachment_dir = nil, -- The local directory for files (see the "summary" section)
|
||||
popup = { -- The popup for comment creation, editing, and replying
|
||||
exit = "<Esc>",
|
||||
perform_action = "<leader>s", -- Once in normal mode, does action (like saving comment or editing description, etc)
|
||||
@@ -144,12 +145,16 @@ git checkout feature-branch
|
||||
|
||||
Then open Neovim. The `project_id` you specify in your configuration file must match the project_id of the Gitlab project your terminal is inside of.
|
||||
|
||||
### Summary
|
||||
|
||||
The `summary` action will pull down the MR description into a buffer so that you can read it. To edit the description, use the `settings.popup.perform_action` keybinding.
|
||||
|
||||
```lua
|
||||
require("gitlab").summary()
|
||||
```
|
||||
|
||||
### Reviewing Diffs
|
||||
|
||||
The `review` action will open a diff of the changes. You can leave comments using the `create_comment` action.
|
||||
|
||||
```lua
|
||||
@@ -157,6 +162,8 @@ require("gitlab").review()
|
||||
require("gitlab").create_comment()
|
||||
```
|
||||
|
||||
The reviewer is Delta by default, but you can configure the plugin to use Diffview instead.
|
||||
|
||||
### Discussions and Notes
|
||||
|
||||
Gitlab groups threads of comments together into "discussions."
|
||||
@@ -177,6 +184,14 @@ If you'd like to create a note in an MR (like a comment, but not linked to a spe
|
||||
require("gitlab").create_note()
|
||||
```
|
||||
|
||||
### Uploading Files
|
||||
|
||||
To attach a file to an MR description, reply, comment, and so forth use the `settings.popup.perform_linewise_action` keybinding when the the popup is open. This will open a picker that will look in the directory you specify in the `settings.attachment_dir` folder (this must be an absolute path) for files.
|
||||
|
||||
When you have picked the file, it will be added to the current buffer at the current line.
|
||||
|
||||
Use the `settings.popup.perform_action` to send the changes to Gitlab.
|
||||
|
||||
### MR Approvals
|
||||
|
||||
You can approve or revoke approval for an MR with the `approve` and `revoke` actions respectively.
|
||||
|
||||
Reference in New Issue
Block a user