docs(update): v1.22.0

bcdady · Jan 10, 2022 · 75d9470 · 75d9470
1 parent 612ff86
commit 75d9470
Show file tree

Hide file tree

Showing 13 changed files with 178 additions and 2 deletions.
diff --git a/docs/source/ci/index.rst b/docs/source/ci/index.rst
@@ -35,6 +35,7 @@ Subcommands
    delete <delete>
    lint <lint>
    list <list>
+   retry <retry>
    run <run>
    status <status>
    trace <trace>

diff --git a/docs/source/ci/retry.rst b/docs/source/ci/retry.rst
@@ -0,0 +1,33 @@
+.. _glab_ci_retry:
+
+glab ci retry
+-------------
+
+Retry a CI job
+
+Synopsis
+~~~~~~~~
+
+
+Retry a CI job
+
+::
+
+  glab ci retry <job-id> [flags]
+
+Examples
+~~~~~~~~
+
+::
+
+  $ glab ci retry 871528
+  
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL
+
diff --git a/docs/source/ci/run.rst b/docs/source/ci/run.rst
@@ -22,6 +22,8 @@ Examples
 
   $ glab ci run
   $ glab ci run -b trunk
+  $ glab ci run -b trunk --variables MYKEY:some_value
+   	$ glab ci run -b trunk --variables MYKEY:some_value --variables KEY2:another_value
   
 
 Options

diff --git a/docs/source/issue/list.rst b/docs/source/issue/list.rst
@@ -36,6 +36,7 @@ Options
       --author string          Filter issue by author <username>
   -c, --closed                 Get only closed issues
   -C, --confidential           Filter by confidential issues
+  -g, --group string           Get issues from group and it's subgroups
       --in string              search in {title|description} (default "title,description")
   -l, --label strings          Filter issue by label <name>
   -m, --milestone string       Filter issue by milestone <id>

diff --git a/docs/source/mr/create.rst b/docs/source/mr/create.rst
@@ -34,6 +34,7 @@ Options
 
       --allow-collaboration    Allow commits from other members
   -a, --assignee usernames     Assign merge request to people by their usernames
+      --copy-issue-labels      Copy labels from issue to the merge request. Used with --related-issue
       --create-source-branch   Create source branch if it does not exist
   -d, --description string     Supply a description for merge request
       --draft                  Mark merge request as a draft
@@ -44,8 +45,11 @@ Options
   -m, --milestone string       The global ID or title of a milestone to assign
       --no-editor              Don't open editor to enter description. If set to true, uses prompt. Default is false
       --push                   Push committed changes after creating merge request. Make sure you have committed changes
+  -i, --related-issue string   Create merge request for an issue. The merge request title will be created from the issue if --title is not provided.
       --remove-source-branch   Remove Source Branch on merge
+      --reviewer usernames     Request review from users by their usernames
   -s, --source-branch string   The Branch you are creating the merge request. Default is the current branch.
+      --squash-before-merge    Squash commits into a single commit when merging
   -b, --target-branch string   The target or base branch into which you want your code merged
   -t, --title string           Supply a title for merge request
   -w, --web                    continue merge request creation on web browser

diff --git a/docs/source/mr/list.rst b/docs/source/mr/list.rst
@@ -42,6 +42,7 @@ Options
       --author string          Fitler merge request by Author <username>
   -c, --closed                 Get only closed merge requests
   -d, --draft                  Filter by draft merge requests
+  -g, --group string           Get MRs from group and it's subgroups
   -l, --label strings          Filter merge request by label <name>
   -M, --merged                 Get only merged merge requests
   -m, --milestone string       Filter merge request by milestone <id>

diff --git a/docs/source/mr/update.rst b/docs/source/mr/update.rst
@@ -39,6 +39,7 @@ Options
   -r, --ready                  Mark merge request as ready to be reviewed and merged
       --remove-source-branch   Remove Source Branch on merge
       --reviewer strings       request review from users by their usernames, prefix with '!' or '-' to remove from existing reviewers, '+' to add, otherwise replace existing reviewers with given users
+      --squash-before-merge    Toggles the option to squash commits into a single commit when merging
       --target-branch string   set target branch
   -t, --title string           Title of merge request
       --unassign               unassign all users

diff --git a/docs/source/repo/create.rst b/docs/source/repo/create.rst
@@ -3,13 +3,13 @@
 glab repo create
 ----------------
 
-Create a new Gitlab project/repository
+Create a new GitLab project/repository
 
 Synopsis
 ~~~~~~~~
 
 
-Create a new GitHub repository.
+Create a new GitLab repository.
 
 ::
 
@@ -46,6 +46,7 @@ Options
   -p, --private                Make project private: visible only to project members
   -P, --public                 Make project public: visible without any authentication
       --readme                 Initialize project with README.md
+      --remoteName origin      Remote name for the Git repository you're in. If not provided, origin by default. (default "origin")
   -t, --tag stringArray        The list of tags for the project.
 
 Options inherited from parent commands

diff --git a/docs/source/repo/index.rst b/docs/source/repo/index.rst
@@ -30,6 +30,7 @@ Subcommands
    create <create>
    delete <delete>
    fork <fork>
+   mirror <mirror>
    search <search>
    view <view>
 

diff --git a/docs/source/repo/mirror.rst b/docs/source/repo/mirror.rst
@@ -0,0 +1,35 @@
+.. _glab_repo_mirror:
+
+glab repo mirror
+----------------
+
+Mirror a project/repository
+
+Synopsis
+~~~~~~~~
+
+
+Mirrors a project/repository to the specified location using pull or push method.
+
+::
+
+  glab repo mirror [ID | URL | PATH] [flags]
+
+Options
+~~~~~~~
+
+::
+
+      --allow-divergence          Determines if divergent refs are skipped.
+      --direction string          Mirror direction (default "pull")
+      --enabled                   Determines if the mirror is enabled. (default true)
+      --protected-branches-only   Determines if only protected branches are mirrored.
+      --url string                The target URL to which the repository is mirrored.
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help   Show help for command
+
diff --git a/docs/source/variable/delete.rst b/docs/source/variable/delete.rst
@@ -0,0 +1,43 @@
+.. _glab_variable_delete:
+
+glab variable delete
+--------------------
+
+Delete a project or group variable
+
+Synopsis
+~~~~~~~~
+
+
+Delete a project or group variable
+
+::
+
+  glab variable delete <key> [flags]
+
+Examples
+~~~~~~~~
+
+::
+
+  $ glab variable delete VAR_NAME
+  $ glab variable delete VAR_NAME --scope=prod
+  $ glab variable delete VARNAME -g mygroup
+  
+
+Options
+~~~~~~~
+
+::
+
+  -g, --group string   Delete variable from a group
+  -s, --scope string   The environment_scope of the variable. All (*), or specific environments (default "*")
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL
+
diff --git a/docs/source/variable/index.rst b/docs/source/variable/index.rst
@@ -31,8 +31,10 @@ Subcommands
    :glob:
    :maxdepth: 0
 
+   delete <delete>
    list <list>
    set <set>
+   update <update>
 
 
 
diff --git a/docs/source/variable/update.rst b/docs/source/variable/update.rst
@@ -0,0 +1,51 @@
+.. _glab_variable_update:
+
+glab variable update
+--------------------
+
+Update an existing project or group variable
+
+Synopsis
+~~~~~~~~
+
+
+Update an existing project or group variable
+
+::
+
+  glab variable update <key> <value> [flags]
+
+Examples
+~~~~~~~~
+
+::
+
+  $ glab variable update WITH_ARG "some value"
+  $ glab variable update FROM_FLAG -v "some value"
+  $ glab variable update FROM_ENV_WITH_ARG "${ENV_VAR}"
+  $ glab variable update FROM_ENV_WITH_FLAG -v"${ENV_VAR}"
+  $ glab variable update FROM_FILE < secret.txt
+  $ cat file.txt | glab variable update SERVER_TOKEN
+  $ cat token.txt | glab variable update GROUP_TOKEN -g mygroup --scope=prod
+  
+
+Options
+~~~~~~~
+
+::
+
+  -g, --group string   Set variable for a group
+  -m, --masked         Whether the variable is masked
+  -p, --protected      Whether the variable is protected
+  -s, --scope string   The environment_scope of the variable. All (*), or specific environments (default "*")
+  -t, --type string    The type of a variable: {env_var|file} (default "env_var")
+  -v, --value string   The value of a variable
+
+Options inherited from parent commands
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+      --help              Show help for command
+  -R, --repo OWNER/REPO   Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL
+