GbUtil 0.14.0
dotnet tool install --global GbUtil --version 0.14.0
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
dotnet tool install --local GbUtil --version 0.14.0
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=GbUtil&version=0.14.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
nuke :add-package GbUtil --version 0.14.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
gitbucket-utility
Utilities for GitBucket
Requirements
- .NET 7.X SDK ※Required only if you use dotnet tool version.
- GitBucket 4.38.X+ (using PostgreSQL as backend DB)
Preparation
# [Required]
# Install as a dotnet tool or download exe from GitHub Release page.
dotnet tool install --global gbutil --version 0.14.0
setx GbUtil_ConnectionStrings Host=host;Username=username;Password=password;Database=gitbucket;port=XXXX
setx GbUtil_GitBucketUri http://localhost:8080/gitbucket/api/v3/
# [Optional]
# You can use your personal access token for authentication/authorization...
setx GbUtil_AccessToken <personal access token>
# ...or username and password credentials.
setx GbUtil_UserName <user name>
setx GbUtil_Password <password>
Usage
gbutil issue -t move
gbutil issue -s|--source -d|--destination -n|--number [-t move]
Move issues between repositories.
> gbutil issue -s root/test1 -d root/test2 -n 1 -t move
Enter your Username: root
Enter your Password: ****
The issue has been successfully moved to http://localhost:8080/gitbucket/root/test2/issues/35.
Close the original one manually.
Options
| Short name | Long name | Required | Abstract |
|---|---|---|---|
-t |
--type |
false |
The type of issue options. Default value is "move". |
-s |
--source |
true |
The source owner and repository to move from. Use "/" for separator like "root/repository1". |
-d |
--destination |
true |
The destination owner and repository to move to. Use "/" for separator like "root/repository2". |
-n |
--number |
true |
The issue numbers to move. Use ":" for separator. |
gbutil issue -t copy
gbutil issue -t copy -s|--source -d|--destination -n|--number
Copy issues between repositories.
> gbutil issue -t copy -s root/test1 -d root/test2 -n 1
Enter your Username: root
Enter your Password: ****
The issue has been successfully copied to http://localhost:8080/gitbucket/root/test2/issues/35.
Options
| Short name | Long name | Required | Abstract |
|---|---|---|---|
-t |
--type |
true |
The type of issue options. Default value is "move". |
-s |
--source |
true |
The source owner and repository to copy from. Use "/" for separator like "root/repository1". |
-d |
--destination |
true |
The destination owner and repository to copy to. Use "/" for separator like "root/repository2". |
-n |
--number |
true |
The issue numbers to copy. Use ":" for separator. |
gbutil milestone
gbutil milestone -o|--owner -r|--repository [-c|--includeClosed]
Show unclosed (by default) milestones.
> gbutil milestone -o ikebe:root
There are 3 open milestones.
* [root/test], [v1.0.0], [2018/07/01], [Bugfix for #123], [ikebe]
* [ikebe/RepeatableTimer], [v0.2.0], [2018/08/01], [Implement xxx feature], [ikebe]
* [ikebe/RepeatableTimer], [v0.3.0], [2019/12/31], [vNext], [user1, user2]
Options
| Short name | Long name | Required | Abstract |
|---|---|---|---|
-o |
--owner |
true |
The owner names of the repositories to show milestones. Use ":" for separator. |
-r |
--repository |
false |
The repository names to show milestones. Use ":" for separator. |
-c |
--includeClosed |
false |
Whether show closed milestones. |
gbutil release
gbutil release -o|--owner -r|--repository -m|--miliestone [--from-pr] [--create-pr]
Output a release note in markdown which lists issues of the repository related to the milistone.
If --create-pr option is specified, gbutil automatically creates Pull Request instead of console output.
> gbutil release -o ikebe -r RepeatableTimer -m v0.1.0
As part of this release we had 4 issues closed.
The highest priority among them is "very high".
### Bug
* Crash when paused #5
* CurrentPeriod reset not working when timer stopped #6
### Enhancement
* Allow one time/repeat options #1
* Add validation #3
> gbutil release -o ikebe -r RepeatableTimer -m v0.1.0 --create-pr
A new pull request has been successfully created!
Options
| Short name | Long name | Required | Abstract |
|---|---|---|---|
-o |
--owner |
true |
The owner name of the repository. |
-r |
--repository |
true |
The repository name. |
-m |
--milestone |
true |
The milestone to publish a release note. |
| - | --from-pr |
false |
If specified, gbutil publish a release note based on pull requests. |
| - | --create-pr |
false |
If specified, gbutil automatically creates a pull request. |
-b |
--base |
false |
The name of the branch you want the changes pulled into. Default value is "master". |
-h |
--head |
false |
The name of the branch where your changes are implemented. Default value is "develop". |
| - | --title |
false |
The title of the new pull request. Default value is the same as milestone. |
-f |
--force |
false |
if specified, force the output/creating PR. |
| - | --draft |
false |
If specified, create draft pull request. |
gbutil backup
gbutil backup --home -d|--dest [--pgdump]
Backup GitBucket repositories and metadata.
> gbutil backup --home "C:\gitbucket" --dest "C:\gitbucket-bk" --pgdump "C:\Program Files\PostgreSQL\12\bin\pg_dump.exe"
Options
| Short name | Long name | Required | Abstract |
|---|---|---|---|
| - | --home |
true |
GITBUCKET_HOME |
-d |
--dest |
true |
The backup destination folder path. |
| - | --pgdump |
false |
The path to the pg_dump executable. If pd_dump is not on your PATH, you need to specify this. |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
This package has no dependencies.
| Version | Downloads | Last updated |
|---|---|---|
| 0.14.0 | 1,744 | 5/16/2023 |
| 0.13.0 | 1,775 | 11/20/2022 |
| 0.12.0 | 2,005 | 2/22/2022 |
| 0.11.0 | 1,735 | 3/20/2021 |
| 0.10.0 | 2,275 | 7/26/2020 |
| 0.9.0 | 2,129 | 2/24/2020 |
| 0.8.0 | 1,974 | 10/11/2019 |
| 0.7.0 | 2,047 | 8/12/2019 |
| 0.6.1 | 2,195 | 6/1/2019 |
| 0.6.0 | 2,028 | 5/5/2019 |
| 0.5.0 | 2,146 | 1/27/2019 |
| 0.4.0 | 2,402 | 12/2/2018 |
| 0.3.0 | 2,379 | 7/29/2018 |
| 0.2.0 | 2,605 | 6/15/2018 |
| 0.1.1 | 2,272 | 6/10/2018 |