Skip to content

docs(runtime/help): add notes about using VERSION in plugins.md #4181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
usfbih8u wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −3
Open

docs(runtime/help): add notes about using VERSION in plugins.md #4181

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions runtime/help/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,7 @@ This file will contain the metadata for your plugin. Here is an example:
Then open a pull request at the [official plugin channel](https://github.com/micro-editor/plugin-channel),
adding a link to the raw `repo.json` that is in your plugin repository.

To make updating the plugin work, the first line of your plugin's lua code
should contain the version of the plugin. (Like this: `VERSION = "1.0.0"`)
Please make sure to use [semver](https://semver.org/) for versioning.
For plugin updates to work, your plugin's Lua code should include its version; for example:

@JoeKar JoeKar Aug 26, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for realizing now after your update, but can we stick to the ~80 line length?
Just some lines with links have the overflow.

`VERSION = "1.0.0"`. Note that `VERSION` is **not** declared as `local`. By convention, this
code is placed on the first line of your plugin's main Lua file. Please make sure to use
[semver](https://semver.org/) for versioning.