Skip to content

Commit ea5e5ee

Browse files
loganintechloganintech
committed
Updated README and added version to subcommands
1 parent bf5bba8 commit ea5e5ee

File tree

4 files changed

+82
-131
lines changed

4 files changed

+82
-131
lines changed

‎README.md‎

Lines changed: 78 additions & 130 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,26 @@ _Note:_ Environment variables can also be passed directly via CLI parameters, th
77
Usage:
88

99
```
10-
Git Publish 0.3.0
10+
Git Publish 0.4.0
1111
Logan Saso <[email protected]>
1212
A small program to create remote git repositories from the command line.
1313
1414
USAGE:
15-
gitpub <SUBCOMMAND>
15+
gitpub [OPTIONS] <SUBCOMMAND>
1616
1717
FLAGS:
1818
-h, --help Prints help information
1919
-V, --version Prints version information
2020
21+
OPTIONS:
22+
--endpoint <endpoint>
23+
2124
SUBCOMMANDS:
2225
bitbucket Create a repo on bitbucket.
2326
github Create a repo on github.
2427
gitlab Create a repo on gitlab.
2528
help Prints this message or the help of the given subcommand(s)
29+
2630
```
2731

2832
## Github Setup
@@ -34,38 +38,36 @@ _Note:_ If you want to create org repositories the token also requires `org` sco
3438

3539
### Github
3640
```
37-
gitpub-github 0.3.0
38-
Logan Saso <[email protected]>
41+
gitpub-github 0.4.0
3942
Create a repo on github.
4043
4144
USAGE:
42-
gitpub github [OPTIONS] --name <name> --token <token>
45+
gitpub github [FLAGS] [OPTIONS] --name <name> --token <token>
4346
4447
FLAGS:
45-
-h, --help Prints help information
46-
-V, --version Prints version information
48+
-i, --disable_issues Disables issues for this repo. Defaults to false.
49+
--merge Enables or disables merging with a merge commit. Defaults to false.
50+
--disable_projects Disables projects for this repo. Defaults to false.
51+
--rebase Enables or disables rebase-merging for this repo. Defaults to false.
52+
--squash Enables or disables squash-merging for this repo. Defaults to false.
53+
-w, --disable_wiki Disables wikis for this repo. Defaults to false.
54+
-h, --help Prints help information
55+
--org Creates the repo under an organization. Requires you have CREATE REPO permissions in
56+
that org.
57+
-p, --private Sets the repository to private. Required 'repo' scope on your personal access token.
58+
-r, --initialize_with_readme Creates an initial commit with empty README.md. Defaults to false.
59+
--team ID of the team that has access to this repo. Only valid when using --org
60+
-V, --version Prints version information
4761
4862
OPTIONS:
49-
--merge <allow_merge_commit> Enables or disables merging with a merge commit. Defaults to true.
50-
--rebase <allow_rebase_merge> Enables or disables rebase-merging for this repo. Defaults to true.
51-
--squash <allow_squash_merge> Enables or disables squash-merging for this repo. Defaults to true.
52-
-r, --initialize_with_readme <auto_init> Creates an initial commit with empty README.md. Defaults to false.
53-
-e, --endpoint <custom_endpoint> Allows redirection of requests to enterprise providers.
54-
-d, --description <description> A short description of the repository.
55-
--gitignore <gitignore_template> Language template: ex 'Rust'. View more templates at
56-
https://github.com/github/gitignore
57-
-i, --issues <has_issues> Enable or disable issues for this repo. Defaults to true.
58-
--projects <has_projects> Enables or disables projects for this repo. Defaults to true.
59-
-w, --wiki <has_wiki> Enables or disables wikis for this repo. Defaults to true.
60-
--homepage <homepage> A URL with more information about the repository.
61-
--license <license_template> License template: ex 'mit' or 'mpl-2.0'. View more at
62-
https://choosealicense.com/
63-
-n, --name <name> The name of the new repository.
64-
--org <org> Creates the repo under an organization. Requires you have CREATE REPO
65-
permissions in that org.
66-
-p, --private <private> Requires 'repo' scope on your personal access token
67-
--team <team_id> Id of the team that has access to this repo. Only valid when using --org.
68-
-t, --token <token> A personal access token. Alternatively read from GITHUB_REPO_TOKEN env variable [env: GITHUB_REPO_TOKEN=<YOUR_TOKEN>]
63+
-d, --description <description> A short description of the repository.
64+
--gitignore <gitignore> Language template: ex 'Rust'. View more templates at
65+
https://github.com/github/gitignore/
66+
--homepage <homepage> A URL with more information about the repository.
67+
--license <license> License template: ex 'mit' or 'mpl-2.0'. View more at https://choosealicense.com/
68+
-n, --name <name> The name of the new repository.
69+
-t, --token <token> A personal access token. Alternatively read from GITHUB_REPO_TOKEN env variable. [env: GITHUB_REPO_TOKEN=<YOUR_TOKEN>]
70+
6971
```
7072

7173
## Gitlab Setup
@@ -78,111 +80,58 @@ _Note_: Optionally set the `GITLAB_USERNAME` environment variable to enable prin
7880

7981
### Gitlab
8082
```
81-
gitpub-gitlab 0.3.0
82-
Logan Saso <[email protected]>
83+
gitpub-gitlab 0.4.0
8384
Create a repo on gitlab.
8485
8586
USAGE:
86-
gitpub gitlab [OPTIONS] --name <name> --path <path> --token <token>
87+
gitpub gitlab [FLAGS] [OPTIONS] --name <name> --path <path> --token <token>
8788
8889
FLAGS:
89-
-h, --help
90-
Prints help information
91-
92-
-V, --version
93-
Prints version information
94-
90+
--disable_container_registry Disables container registry for this repo.
91+
-i, --disable_issues Disables issues for this repo.
92+
--disable_jobs Disables jobs for this repo.
93+
--disable_merge Disables merging with a merge commit.
94+
--disable_shared_runners Disables shared runners for this repo.
95+
--disable_snippets Disables snippets for this repo.
96+
-w, --disable_wiki Disables wikis for this repo.
97+
--discussion_resolution_required Requires discussions are resolved before a merge.
98+
-h, --help Prints help information
99+
-r, --initialize_with_readme Create a blank README for the project.
100+
--large_file_support Enables git large file support.
101+
--merge_request_link_on_commit Print the merge request link when committing to the repository.
102+
--mirror Enables pull mirroring in a project.
103+
--mirror_triggers_builds Enables builds on pull mirroring.
104+
--pipeline_success_required Requires pipelines to succeed before a merge.
105+
--public_builds Lets jobs be viewed by non-project members.
106+
--request_access_enabled Allow users to request member access.
107+
-V, --version Prints version information
95108
96109
OPTIONS:
97-
--approvals_before_merge <approvals_before_merge>
98-
Number of approvals required before a merge.
99-
100-
--ci_config_path <ci_config_path>
101-
Path to CI config file.
102-
103-
--container_registry <container_registry_enabled>
104-
Enables or disables container registry for this repo.
105-
106-
--default_branch <default_branch>
107-
Set default branch. Defaults to master.
108-
109-
-e, --endpoint <custom_endpoint>
110-
Allows redirection of requests to enterprise providers.
111-
112-
-d, --description <description>
113-
A short description of the repository.
114-
115-
--import_url <import_url>
116-
Supply a URL to import a repo from.
117-
118-
-r, --initialize_with_readme <initialize_with_readme>
119-
Create a blank README in the project.
120-
121-
-i, --issues <issues_enabled>
122-
Enable or disable issues for this repo. Defaults to true.
123-
124-
--jobs <jobs_enabled>
125-
Enables or disables jobs for this repo.
126-
127-
--lfs <lfs_enabled>
128-
Enables git large file support.
129-
110+
--approvals_before_merge <approvals_before_merge> Number of approvals required before a merge.
111+
--ci_config_path <ci_config_path> Path to CI config file.
112+
--default_branch <default_branch> Set default branch. Defaults to master.
113+
-d, --description <description> A short description of the repository.
114+
--import_url <import_url> Supply a URL to import a repo from.
130115
--merge_method <merge_method>
131-
Sets the merge method.
132-
133-
--merge <merge_requests_enabled>
134-
Enables or disables merge requests. Defaults to true.
135-
136-
--mirror <mirror>
137-
Enables pull mirroring in a project.
138-
139-
--mirror_trigger_builds <mirror_trigger_builds>
140-
Enables builds on pull mirroring.
141-
142-
-n, --name <name>
143-
The name of the new project. Equals path if not provided.
116+
Sets the merge method. [possible values: merge, rebase_merge, ff]
144117
118+
-n, --name <name> The name of the new repository.
145119
--namespace_id <namespace_id>
146120
Namespace for the new project (defaults to the current user’s namespace)
147121
148-
--discussion_resolution_required <only_allow_merge_if_all_discussions_are_resolved>
149-
Requires discussions are resolved before a merge.
150-
151-
--pipeline_success_required <only_allow_merge_if_pipeline_succeeds>
152-
Requires pipelines to succeed before a merge.
153-
154122
--path <path>
155-
Repository name for new project. Generated based on name if not provided (generated lowercased with dashes).
156-
157-
--merge_request_link_on_commit <printing_merge_request_link_enabled>
158-
Print the merge request link when committing to the repository.
159-
160-
--public_builds <public_builds>
161-
Lets jobs be viewed by non-project members.
123+
The path for the new repo. Generated based on name if not provided (generated lowercased with dashes).
162124
163125
--repository_storage <repository_storage>
164-
Which storage shard the repo is one. Available only to admins.
165-
166-
--request_access_enabled <request_access_enabled>
167-
Allow users to request member access.
168-
169-
--shared_runners <shared_runners_enabled>
170-
Enables or disables shared runners for this repo.
171-
172-
--snippets <snippets_enabled>
173-
Enables or disables snippets for this repo.
126+
An advanced parameter to designate which shard the repo is on, available only to admins.
174127
175128
--tag_list <tag_list>...
176-
A list of tags for a repo.
129+
A list of tags for a repo. Takes up to four params. `--tag_list first second third tag`
177130
178131
-t, --token <token>
179-
A personal access token. Alternatively read from GITLAB_REPO_TOKEN env variable [env: GITLAB_REPO_TOKEN=<YOUR_TOKEN>]
180-
181-
-p, --visibility <visibility>
182-
The visibility of the project. [possible values: public, internal, private]
183-
184-
-w, --wiki <wiki_enabled>
185-
Enables or disables wikis for this repo. Defaults to true.
132+
A personal access token. Alternatively read from GITLAB_REPO_TOKEN env variable. [env: GITLAB_REPO_TOKEN=<YOUR_TOKEN>]
133+
--visibility <visibility>
134+
The visibility of the project [possible values: public, internal, private]
186135
```
187136

188137
## BitBucket Setup
@@ -194,28 +143,27 @@ OPTIONS:
194143
### Bitbucket
195144

196145
```
197-
gitpub-bitbucket 0.3.0
198-
Logan Saso <[email protected]>
146+
gitpub-bitbucket 0.4.0
199147
Create a repo on bitbucket.
200148
201149
USAGE:
202-
gitpub bitbucket [OPTIONS] --name <name> --token <token> --username <username>
150+
gitpub bitbucket [FLAGS] [OPTIONS] --name <name> --token <token> --username <username>
203151
204152
FLAGS:
205-
-h, --help Prints help information
206-
-V, --version Prints version information
153+
-i, --disable_issues Disables issues for this repo. Defaults to false.
154+
-w, --disable_wiki Disables wikis for this repo. Defaults to false.
155+
-h, --help Prints help information
156+
--language Give bitbucket a hint about the programming language.
157+
-p, --private Sets the repository to private.
158+
-V, --version Prints version information
207159
208160
OPTIONS:
209-
-e, --endpoint <custom_endpoint> Allows redirection of requests to enterprise providers.
210-
-d, --description <description> A short description of the repository.
211-
--fork_policy <fork_policy> Allow public forking of this repo. [possible values: allow_forks, no_public_forks, no_forks]
212-
-i, --issues <has_issues> Enable or disable issues for this repo. Defaults to true.
213-
-w, --wiki <has_wiki> Enables or disables wikis for this repo. Defaults to true.
214-
-p, --private <is_private> Sets whether or not the repository is private.
215-
--language <language> Give bitbucket a hint about the programming language.
216-
-n, --name <name> The name of the new repository.
217-
--scm <scm> Control the underlying source control method. [possible values: hg, git]
218-
-t, --token <token> A personal access token. Alternatively read from BITBUCKET_REPO_TOKEN env variable [env: BITBUCKET_REPO_TOKEN=<YOUR_APP_PASSWORD>]
219-
--username <username> Your bitbucket username. Alternatively read from BITBUCKET_USERNAME env variable [env: BITBUCKET_USERNAME=<YOUR_USERNAME>]
220-
--homepage <website> A URL with more information about the repository.
161+
-d, --description <description> A short description of the repository.
162+
-e, --endpoint <endpoint> Allows redirection of requests to enterprise providers.
163+
--fork_policy <fork_policy> Changes the allowed forking method for this repo. [possible values: allow_forks,
164+
no_public_forks, no_forks]
165+
-n, --name <name> The name of the new repository.
166+
--scm <scm> Control underlying source control method. [possible values: git, hg]
167+
-t, --token <token> A personal access token. Alternatively read from BITBUCKET_REPO_TOKEN env variable. [env: BITBUCKET_REPO_TOKEN=<YOUR_TOKEN>]
168+
--username <username> Your bitbucket username. Alternatively read from BITBUCKET_USERNAME env variable. [env: BITBUCKET_USERNAME=<YOUR_USERNAME>]
221169
```

‎src/provider/bitbucket.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ impl<'a> Provider for BitbucketArgs<'a> {
5353

5454
pub fn subcommand() -> App<'static, 'static> {
5555
SubCommand::with_name("bitbucket")
56+
.version("0.4.0")
5657
.about("Create a repo on bitbucket.")
5758
.arg(
5859
Arg::with_name("name")

‎src/provider/github.rs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ impl<'a> Provider for GithubArgs<'a> {
6464

6565
pub fn subcommand() -> App<'static, 'static> {
6666
SubCommand::with_name("github")
67+
.version("0.4.0")
6768
.about("Create a repo on github.")
6869
.arg(
6970
Arg::with_name("name")

‎src/provider/gitlab.rs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ impl<'a> Provider for GitlabArgs<'a> {
9191

9292
pub fn subcommand() -> App<'static, 'static> {
9393
SubCommand::with_name("gitlab")
94+
.version("0.4.0")
9495
.about("Create a repo on gitlab.")
9596
.arg(
9697
Arg::with_name("name")
@@ -208,7 +209,7 @@ pub fn subcommand() -> App<'static, 'static> {
208209
.takes_value(true)
209210
.multiple(true)
210211
.max_values(4)
211-
.help("A list of tags for a repo.")
212+
.help("A list of tags for a repo. Takes up to four params. `--tag_list first second third tag`")
212213
)
213214
.arg(
214215
Arg::with_name("merge_request_link_on_commit")

0 commit comments

Comments
 (0)