diff --git a/README.md b/README.md index a472093..fdd51c6 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Toggle the Rovo Dev terminal with a simple command or keymap: Or use the default keymap `` in normal or terminal mode. The plugin also supports Rovo Dev CLI flags: + ```vim :RovoDevRestore " Start with --restore flag :RovoDevVerbose " Start with --verbose flag @@ -33,10 +34,6 @@ The plugin also supports Rovo Dev CLI flags: ```lua { "atlassian-labs/rovo-dev.nvim", - cmd = { "RovoDevToggle" }, - config = function(_, opts) - require("rovo-dev").setup(opts) - end, opts = { terminal = { cmd = { "acli", "rovodev", "run" }, @@ -152,6 +149,7 @@ Contributions to rovo-dev.nvim are welcome! Please see [CONTRIBUTING.md](CONTRIB ## Versioning policy We follow Semantic Versioning (SemVer) using Git tags of the form `vX.Y.Z`. + - MAJOR: Breaking changes to the user-facing API (Lua API, commands, config schema, or documented behavior) - MINOR: Backward-compatible features - PATCH: Backward-compatible bug fixes @@ -168,7 +166,8 @@ We maintain a human-readable changelog in `CHANGELOG.md` (Keep a Changelog style Two supported paths: -1) Tag-driven release (recommended) +1. Tag-driven release (recommended) + - Update `CHANGELOG.md` and `lua/rovo-dev/version.lua` (no leading `v` in the file) - Commit your changes - Create and push a tag: @@ -180,12 +179,14 @@ git push origin vX.Y.Z - CI will verify that `version.lua` matches the tag and create the GitHub release -2) Manual release (workflow dispatch) +2. Manual release (workflow dispatch) + - In GitHub Actions, run the “Release” workflow manually - Provide the version as `X.Y.Z` (no leading `v`) - The workflow will write `lua/rovo-dev/version.lua`, commit, push, and create the release Notes + - Avoid force-updating or reusing tags - Optionally sign tags: `git tag -s vX.Y.Z -m "vX.Y.Z"` diff --git a/doc/rovo-dev.txt b/doc/rovo-dev.txt index a5c5056..ac5d9b3 100644 --- a/doc/rovo-dev.txt +++ b/doc/rovo-dev.txt @@ -38,10 +38,6 @@ INSTALLATION *rovo-dev-installation Using lazy.nvim (recommended): >lua { "atlassian-labs/rovo-dev.nvim", - cmd = { "RovoDevToggle" }, - config = function(_, opts) - require("rovo-dev").setup(opts) - end, opts = { terminal = { cmd = { "acli", "rovodev", "run" }, diff --git a/doc/tags b/doc/tags new file mode 100644 index 0000000..cd6df66 --- /dev/null +++ b/doc/tags @@ -0,0 +1,22 @@ +:RovoDevRestore rovo-dev.txt /*:RovoDevRestore* +:RovoDevShadow rovo-dev.txt /*:RovoDevShadow* +:RovoDevToggle rovo-dev.txt /*:RovoDevToggle* +:RovoDevVerbose rovo-dev.txt /*:RovoDevVerbose* +:RovoDevYolo rovo-dev.txt /*:RovoDevYolo* +rovo-dev-api rovo-dev.txt /*rovo-dev-api* +rovo-dev-behavior rovo-dev.txt /*rovo-dev-behavior* +rovo-dev-commands rovo-dev.txt /*rovo-dev-commands* +rovo-dev-config-file-refresh rovo-dev.txt /*rovo-dev-config-file-refresh* +rovo-dev-config-keymaps rovo-dev.txt /*rovo-dev-config-keymaps* +rovo-dev-config-terminal rovo-dev.txt /*rovo-dev-config-terminal* +rovo-dev-config-window rovo-dev.txt /*rovo-dev-config-window* +rovo-dev-configuration rovo-dev.txt /*rovo-dev-configuration* +rovo-dev-contents rovo-dev.txt /*rovo-dev-contents* +rovo-dev-contributing rovo-dev.txt /*rovo-dev-contributing* +rovo-dev-installation rovo-dev.txt /*rovo-dev-installation* +rovo-dev-introduction rovo-dev.txt /*rovo-dev-introduction* +rovo-dev-license rovo-dev.txt /*rovo-dev-license* +rovo-dev-usage rovo-dev.txt /*rovo-dev-usage* +rovo-dev.setup() rovo-dev.txt /*rovo-dev.setup()* +rovo-dev.toggle() rovo-dev.txt /*rovo-dev.toggle()* +rovo-dev.txt rovo-dev.txt /*rovo-dev.txt* diff --git a/lua/rovo-dev/init.lua b/lua/rovo-dev/init.lua index 334f660..0769daf 100644 --- a/lua/rovo-dev/init.lua +++ b/lua/rovo-dev/init.lua @@ -26,7 +26,7 @@ function M.setup(opts) keymaps.register_keymaps(M) -- Register commands - commands.register_commands(M.config) + commands.register_commands(M) return M end