https://github.com/zeioth/distroupdate.nvim
Neovim plugin to update your current distro from its github remote
https://github.com/zeioth/distroupdate.nvim
neovim-plugin neovim-plugins nvim-plugin nvim-plugins update updater
Last synced: about 1 year ago
JSON representation
Neovim plugin to update your current distro from its github remote
- Host: GitHub
- URL: https://github.com/zeioth/distroupdate.nvim
- Owner: Zeioth
- License: gpl-3.0
- Created: 2024-01-23T16:34:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T14:30:33.000Z (over 1 year ago)
- Last Synced: 2025-03-18T13:29:04.059Z (about 1 year ago)
- Topics: neovim-plugin, neovim-plugins, nvim-plugin, nvim-plugins, update, updater
- Language: Lua
- Homepage:
- Size: 243 KB
- Stars: 12
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# distroupdate.nvim
Distro agnostic Neovim plugin to upgrade your current distro from its github remote.
## Table of contents
- [Why](#why)
- [How to install](#how-to-install)
- [Available commands](#available-commands)
- [Available options](#available-options)
- [Example of a real config](#example-of-a-real-config)
- [FAQ](#faq)
## Why
If you use Neovim in multiple machines, you can use the command `:DistroUpdate`
to get the latest changes of your config from your GitHub repository from any
device.
If you are developing a Neovim distro, you can ship this plugin, and users will
get updates from your distro GitHub repository when they run `:DistroUpdate`.
### Warning
Running `:DistroUpdate` will overwrite any uncommited change in your
local nvim config.
## How to install
This plugin requires you to use lazy package manager
```lua
{
"Zeioth/distroupgrade.nvim",
dependencies = "nvim-lua/plenary.nvim",
event = "VeryLazy",
opts = {}
}
```
## Available commands
| Command | Description |
|----------------------------------|---------------------------------------------------------------------------------------------------------|
| **:DistroUpdate** | If the value of the option `channel` is `stable`, it will update from the latest available released version of the `remote` of the git repository of your nvim config. If the value of `channel` is `nightly`, it will update from the latest changes in the branch `nightly` of the git repository of your nvim config. |
| **:DistroUpdateRevert** | Uses git to bring your config to the state it had before running `:DistroUpdate`. |
| **:DistroFreezePluginVersions** | Saves your current plugin versions into `lazy_versions.lua` in your config directory. You can import this file and pass it to your lazy config, so it respects your locked versions. [Check the option `spec` in lazy](https://github.com/folke/lazy.nvim). |
| **:DistroReadVersion** | Prints the commit number of the current distro version. |
| **:DistroReadChangelog** | Prints the changelog. |
## Available options
All options described here are 100% optional and you don't need to define them to use this plugin.
### Updater options
Options to configure what version/commit will be downloaded.
| Name | Default value | Description |
|---------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **channel** | `stable` | Channel used by the command `:DistroUpdate`. `stable` will update the distro from the latest available released version of your git repository. `nightly` will update the distro from the nightly branch of your git repository. |
| **commit** | `nil` | If this option is specified, it will prevail over `release_tag` and `channel`. |
| **release_tag** | `nil` | If this option is specified, it will prevail over `channel`. The format must be semantic versioning, like: `"v1.0"`. |
| **remote** | `origin`| If you have multiple remotes, you can specify the one to use with this option. |
### Updater UX options
Options to configure what happen during the update.
| Name | Default value | Description |
|-------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------|
| **overwrite_uncommitted_local_changes** | `true` | If true, uncommitted local changes will be lost. If false, the update will fail with an error. |
| **update_plugins** | `true` | If true, after `:DistroUpdate`, plugins will update automatically before closing Neovim. If false, you will have to update them manually using lazy. |
| **on_update_show_changelog** | `true` | If true, after `:DistroUpdate`, the changes of the new version will be displayed. |
| **on_update_auto_quit** | `false` | If true, after `:DistroUpdate`, Neovim will close automatically. If false, you will have to close it manually to ensure stability. |
| **auto_accept_prompts** | `false` | If true, all prompts in `:DistroUpdate` will be accepted automatically. |
### Versioning options
Options to configure where to store the plugins file and the rollback file.
| Name | Default value | Description |
|-------------------|------------------------------------------------|-----------------------------------------------------------------------------|
| **snapshot_file** | `/lua/lazy_snapshot.lua` | File used by the command `:DistroFreezePluginVersions` to write the plugins. |
| **rollback_file** | `/rollback.lua` | Rollback file automatically triggered by `:DistroUpdate`. This file will be used when you use `:DistroUpdateRevert`. |
## Example of a real config
```lua
-- distroupdate.nvim [distro update]
-- https://github.com/Zeioth/distroupdate.nvim
{
"Zeioth/distroupdate.nvim",
dependencies = { "nvim-lua/plenary.nvim" },
event = "VeryLazy",
opts = {
channel = "stable"
}
},
```
## How to pass the plugins file to lazy
If you've used `:DistroFreezePluginVersions` you have to pass the generated file to lazy, so it can use it. For that use the `spec` option. You can find an example [here](https://github.com/NormalNvim/NormalNvim/blob/main/lua/base/2-lazy.lua).
## 🌟 Get involved
One of the biggest challenges NormalNvim face is marketing. So share the project and tell your friends!
[](https://starchart.cc/Zeioth/distroupdate.nvim)
## Fix a bug and send a PR to appear as contributor
## Credits
The GPL3 lua libraries this plugin use come from NormalNvim (Full rewrite) and AstroNvim (Foundation and git wrapper).
So please support both projects if you enjoy this plugin.
## FAQ
* **Is this plugin automatic?** NO. This plugin will do nothing unless you run one of its commands.
* **Where do the updates come from?** From your own git repo. You are the only one in control.
* **Why not just using lazy alone?** If lazy covers your case of use, that's totally fine. But there will be scenarios where you are gonna need distroupdate.
## Roadmap
* It would be ideal to write unit tests to ensure we don't introduce regressions or breaking changes in future versions.