diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 57437cb..71a1bc6 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -13,10 +13,10 @@ jobs: tests: uses: ./.github/workflows/nupm-tests.yml with: - nu_version: "0.89.0" + nu_version: "0.90.1" nupm_revision: "66e2eaa848e3f72c1b4a841f26f4dc7efc4fedb9" documentation: uses: ./.github/workflows/check-documentation.yml with: - nu_version: "0.89.0" + nu_version: "0.90.1" diff --git a/docs/nu-git-manager-sugar/dotfiles/index.md b/docs/nu-git-manager-sugar/dotfiles/index.md index 244dc3d..73239e1 100644 --- a/docs/nu-git-manager-sugar/dotfiles/index.md +++ b/docs/nu-git-manager-sugar/dotfiles/index.md @@ -2,6 +2,9 @@ ## Description the `dotfiles` module ships the `gm cfg` command +the goal of `gm cfg` is to provide tools to interact with dotfiles managed +through a _bare_ repo. + ## Commands - [`gm cfg`](gm-cfg.md) - [`gm cfg edit`](gm-cfg-edit.md) \ No newline at end of file diff --git a/docs/nu-git-manager-sugar/extra/index.md b/docs/nu-git-manager-sugar/extra/index.md index 13eb6fd..ef614da 100644 --- a/docs/nu-git-manager-sugar/extra/index.md +++ b/docs/nu-git-manager-sugar/extra/index.md @@ -2,5 +2,7 @@ ## Description extends the core `gm` command with additional subcommands. +/!\ this module is part of the optional NGM. /!\ + ## Commands - [`gm report`](gm-report.md) \ No newline at end of file diff --git a/docs/nu-git-manager-sugar/git/index.md b/docs/nu-git-manager-sugar/git/index.md index c7fd088..74bd78e 100644 --- a/docs/nu-git-manager-sugar/git/index.md +++ b/docs/nu-git-manager-sugar/git/index.md @@ -2,6 +2,8 @@ ## Description ships a bunch of helper commands that augments the capabilities of Git. +/!\ this module is part of the optional NGM. /!\ + ## Commands - [`gm repo bisect`](gm-repo-bisect.md) - [`gm repo branch interactive-delete`](gm-repo-branch-interactive-delete.md) diff --git a/docs/nu-git-manager-sugar/git/prompt/index.md b/docs/nu-git-manager-sugar/git/prompt/index.md index 678e21b..8048c66 100644 --- a/docs/nu-git-manager-sugar/git/prompt/index.md +++ b/docs/nu-git-manager-sugar/git/prompt/index.md @@ -2,5 +2,7 @@ ## Description provides a command to setup a Git-based prompt for Nushell. +/!\ this module is part of the optional NGM. /!\ + ## Commands - [`setup`](setup.md) \ No newline at end of file diff --git a/docs/nu-git-manager-sugar/github/index.md b/docs/nu-git-manager-sugar/github/index.md index 5489256..e8b5d73 100644 --- a/docs/nu-git-manager-sugar/github/index.md +++ b/docs/nu-git-manager-sugar/github/index.md @@ -2,6 +2,8 @@ ## Description provides helper commands to simplify the use of the GitHub CLI. +/!\ this module is part of the optional NGM. /!\ + ## Commands - [`gm gh pr checkout`](gm-gh-pr-checkout.md) - [`gm gh query-api`](gm-gh-query-api.md) diff --git a/docs/nu-git-manager-sugar/index.md b/docs/nu-git-manager-sugar/index.md index 9c763f6..981a0db 100644 --- a/docs/nu-git-manager-sugar/index.md +++ b/docs/nu-git-manager-sugar/index.md @@ -3,6 +3,10 @@ `nu-git-manager-sugar` is the additional module and package of NGM, with sugar on top. +it ships things like extensions to the core `gm` command, augments Git with +automation commands and can provide helper commands around utilities such as +the GitHub CLI. + ## Commands no commands diff --git a/docs/nu-git-manager/index.md b/docs/nu-git-manager/index.md index ce19d8b..c7bdcd1 100644 --- a/docs/nu-git-manager/index.md +++ b/docs/nu-git-manager/index.md @@ -2,6 +2,12 @@ ## Description `nu-git-manager` is the core module and package of NGM. +it features all required commands to interact with and manage Git repos. + +this module ships the `gm` command and a bunch of subcommands, allowing you to +clone, list, remove, ..., repositories without worrying about where they are +on your filesystem! + ## Commands - [`gm`](gm.md) - [`gm clean`](gm-clean.md) diff --git a/pkgs/nu-git-manager-sugar/nupm.nuon b/pkgs/nu-git-manager-sugar/nupm.nuon index bee1672..a884a30 100644 --- a/pkgs/nu-git-manager-sugar/nupm.nuon +++ b/pkgs/nu-git-manager-sugar/nupm.nuon @@ -1,6 +1,6 @@ { name: "nu-git-manager-sugar" - version: 0.5.0 + version: 0.6.0 description: "A collection of extra Nushell tools to manage `git` repositories." documentation: "https://github.com/amtoine/nu-git-manager/blob/main/README.md" maintainers: [ @@ -9,7 +9,7 @@ ] license: "https://github.com/amtoine/nu-git-manager/blob/main/LICENSE" dependencies: { - nushell: 0.89.0 + nushell: 0.90.1 git: 2.40.1 optionals: { "sugar gh": { diff --git a/pkgs/nu-git-manager/nupm.nuon b/pkgs/nu-git-manager/nupm.nuon index 9fa9895..6cc771c 100644 --- a/pkgs/nu-git-manager/nupm.nuon +++ b/pkgs/nu-git-manager/nupm.nuon @@ -1,6 +1,6 @@ { name: "nu-git-manager" - version: 0.5.0 + version: 0.6.0 description: "A collection of Nushell tools to manage `git` repositories." documentation: "https://github.com/amtoine/nu-git-manager/blob/main/README.md" maintainers: [ @@ -9,7 +9,7 @@ ] license: "https://github.com/amtoine/nu-git-manager/blob/main/LICENSE" dependencies: { - nushell: 0.89.0 + nushell: 0.90.1 git: 2.40.1 } type: "module" diff --git a/toolkit.nu b/toolkit.nu index 8c82379..a34b0cb 100644 --- a/toolkit.nu +++ b/toolkit.nu @@ -325,6 +325,8 @@ def document-module [ "## Description", $module.usage, "", + $module.extra_usage, + "", "## Commands", $commands, ]