From f95b6ea90c1db6fa0d3c96f5a63235578fa00f86 Mon Sep 17 00:00:00 2001 From: Kai Armstrong Date: Fri, 21 Oct 2022 14:38:48 +0000 Subject: [PATCH] docs: add linting and checks to documentation --- .gitlab-ci.yml | 10 + .markdownlint.yml | 153 +++ .vale.ini | 12 + README.md | 95 +- cmd/gen-docs/docs.go | 28 +- commands/alias/set/alias_set.go | 2 +- commands/api/api.go | 67 +- commands/auth/login/helper.go | 2 +- commands/auth/login/login.go | 8 +- commands/ci/artifact/artifact.go | 4 +- commands/ci/delete/delete.go | 4 +- commands/ci/legacyci/pipeline_ci.go | 2 +- commands/ci/lint/lint.go | 2 +- commands/ci/list/list.go | 4 +- commands/ci/retry/retry.go | 2 +- commands/ci/run/run.go | 8 +- commands/ci/status/status.go | 8 +- commands/ci/view/view.go | 10 +- commands/completion/completion.go | 39 +- commands/config/config.go | 33 +- commands/issue/close/issue_close.go | 4 +- commands/issue/create/issue_create.go | 10 +- commands/issue/delete/issue_delete.go | 6 +- commands/issue/issue.go | 8 +- commands/issue/list/issue_list.go | 8 +- commands/issue/reopen/issue_reopen.go | 6 +- commands/issue/subscribe/issue_subscribe.go | 6 +- .../issue/unsubscribe/issue_unsubscribe.go | 6 +- commands/issue/update/issue_update.go | 4 +- commands/issue/view/issue_view.go | 10 +- commands/label/create/label_create.go | 6 +- commands/label/list/label_list.go | 6 +- commands/mr/approve/mr_approve.go | 10 +- commands/mr/checkout/mr_checkout.go | 10 +- commands/mr/close/mr_close.go | 12 +- commands/mr/create/mr_create.go | 10 +- commands/mr/delete/mr_delete.go | 10 +- commands/mr/diff/diff.go | 8 +- commands/mr/for/mr_for.go | 8 +- commands/mr/issues/mr_issues.go | 6 +- commands/mr/list/mr_list.go | 20 +- commands/mr/merge/mr_merge.go | 6 +- commands/mr/mr.go | 6 +- commands/mr/rebase/mr_rebase.go | 9 +- commands/mr/reopen/mr_reopen.go | 8 +- commands/mr/revoke/mr_revoke.go | 12 +- commands/mr/subscribe/mr_subscribe.go | 8 +- commands/mr/unsubscribe/mr_unsubscribe.go | 8 +- commands/mr/update/mr_update.go | 6 +- commands/project/archive/repo_archive.go | 9 +- commands/project/clone/repo_clone.go | 15 +- commands/project/create/project_create.go | 4 +- commands/project/delete/delete.go | 4 +- commands/project/fork/fork.go | 6 +- commands/project/list/list.go | 2 +- commands/project/mirror/project_mirror.go | 4 +- commands/project/search/project_search.go | 8 +- commands/project/transfer/project_transfer.go | 2 +- commands/project/view/project_view.go | 3 +- commands/release/create/create.go | 24 +- commands/release/delete/delete.go | 2 +- commands/release/upload/upload.go | 16 +- commands/release/view/view.go | 4 +- commands/snippet/create/create.go | 6 +- commands/snippet/snippet.go | 2 +- commands/ssh-key/get/get.go | 4 +- commands/ssh-key/list/list.go | 6 +- commands/ssh-key/ssh-key.go | 4 +- commands/variable/delete/delete.go | 6 +- commands/variable/get/get.go | 4 +- commands/variable/list/list.go | 2 +- commands/variable/set/set.go | 14 +- commands/variable/update/update.go | 14 +- docs/.vale/gitlab/Admin.yml | 13 + docs/.vale/gitlab/AlertBoxStyle.yml | 20 + docs/.vale/gitlab/BadPlurals.yml | 13 + docs/.vale/gitlab/BadgeCapitalization.yml | 14 + docs/.vale/gitlab/British.yml | 120 +++ docs/.vale/gitlab/CIConfigFile.yml | 17 + docs/.vale/gitlab/CodeblockFences.yml | 13 + docs/.vale/gitlab/CurlStringsQuoted.yml | 13 + docs/.vale/gitlab/CurrentStatus.yml | 14 + docs/.vale/gitlab/DefaultBranch.yml | 14 + docs/.vale/gitlab/Dropdown.yml | 14 + docs/.vale/gitlab/EOLWhitespace.yml | 13 + docs/.vale/gitlab/ElementDescriptors.yml | 13 + docs/.vale/gitlab/FirstPerson.yml | 16 + docs/.vale/gitlab/FutureTense.yml | 16 + docs/.vale/gitlab/HeadingContent.yml | 18 + docs/.vale/gitlab/HeadingDepth.yml | 13 + docs/.vale/gitlab/InclusionAbleism.yml | 14 + docs/.vale/gitlab/InclusionCultural.yml | 16 + docs/.vale/gitlab/InclusionGender.yml | 18 + docs/.vale/gitlab/InternalLinkCase.yml | 13 + docs/.vale/gitlab/InternalLinkExtension.yml | 13 + docs/.vale/gitlab/InternalLinkFormat.yml | 13 + docs/.vale/gitlab/LatinTerms.yml | 17 + docs/.vale/gitlab/Markdown_emoji.yml | 13 + docs/.vale/gitlab/MeaningfulLinkWords.yml | 15 + docs/.vale/gitlab/MergeConflictMarkers.yml | 13 + docs/.vale/gitlab/MultiLineLinks.yml | 14 + docs/.vale/gitlab/NonStandardQuotes.yml | 14 + docs/.vale/gitlab/OutdatedVersions.yml | 24 + docs/.vale/gitlab/OxfordComma.yml | 12 + docs/.vale/gitlab/Possessive.yml | 13 + docs/.vale/gitlab/ReadingLevel.yml | 13 + docs/.vale/gitlab/ReferenceLinks.yml | 13 + docs/.vale/gitlab/RelativeLinks.yml | 13 + .../gitlab/RelativeLinksDoubleSlashes.yml | 13 + docs/.vale/gitlab/Repetition.yml | 12 + docs/.vale/gitlab/SentenceLength.yml | 13 + docs/.vale/gitlab/SentenceSpacing.yml | 14 + docs/.vale/gitlab/Simplicity.yml | 18 + docs/.vale/gitlab/Spelling.yml | 16 + docs/.vale/gitlab/SubstitutionSuggestions.yml | 28 + docs/.vale/gitlab/SubstitutionWarning.yml | 29 + docs/.vale/gitlab/Substitutions.yml | 62 ++ docs/.vale/gitlab/ToDo.yml | 14 + docs/.vale/gitlab/UnclearAntecedent.yml | 22 + docs/.vale/gitlab/Uppercase.yml | 252 +++++ docs/.vale/gitlab/VersionText.yml | 19 + docs/.vale/gitlab/VersionTextSingleLine.yml | 13 + docs/.vale/gitlab/Wordy.yml | 17 + docs/.vale/gitlab/spelling-exceptions.txt | 879 ++++++++++++++++++ docs/.vale/vale.tmpl | 51 + docs/README.md | 4 +- docs/release_process.md | 8 +- docs/security_releases.md | 18 +- docs/source/alias/delete.md | 5 +- docs/source/alias/help.md | 10 +- docs/source/alias/index.md | 5 +- docs/source/alias/list.md | 5 +- docs/source/alias/set.md | 10 +- docs/source/api/index.md | 22 +- docs/source/auth/git-credential.md | 7 +- docs/source/auth/help.md | 10 +- docs/source/auth/index.md | 5 +- docs/source/auth/login.md | 12 +- docs/source/auth/status.md | 8 +- docs/source/check-update/index.md | 5 +- docs/source/ci/artifact.md | 11 +- docs/source/ci/ci.md | 7 +- docs/source/ci/delete.md | 11 +- docs/source/ci/help.md | 10 +- docs/source/ci/index.md | 7 +- docs/source/ci/lint.md | 7 +- docs/source/ci/list.md | 11 +- docs/source/ci/retry.md | 7 +- docs/source/ci/run.md | 15 +- docs/source/ci/status.md | 15 +- docs/source/ci/trace.md | 7 +- docs/source/ci/view.md | 18 +- docs/source/completion/index.md | 37 +- docs/source/config/get.md | 13 +- docs/source/config/help.md | 10 +- docs/source/config/index.md | 14 +- docs/source/config/init.md | 14 +- docs/source/config/set.md | 12 +- docs/source/index.md | 39 +- docs/source/issue/board.md | 5 +- docs/source/issue/close.md | 9 +- docs/source/issue/create.md | 17 +- docs/source/issue/delete.md | 11 +- docs/source/issue/help.md | 10 +- docs/source/issue/index.md | 15 +- docs/source/issue/list.md | 15 +- docs/source/issue/note.md | 7 +- docs/source/issue/reopen.md | 11 +- docs/source/issue/subscribe.md | 11 +- docs/source/issue/unsubscribe.md | 11 +- docs/source/issue/update.md | 11 +- docs/source/issue/view.md | 17 +- docs/source/label/create.md | 13 +- docs/source/label/help.md | 10 +- docs/source/label/index.md | 7 +- docs/source/label/list.md | 13 +- docs/source/mr/approve.md | 17 +- docs/source/mr/approvers.md | 5 +- docs/source/mr/checkout.md | 17 +- docs/source/mr/close.md | 17 +- docs/source/mr/create.md | 17 +- docs/source/mr/delete.md | 15 +- docs/source/mr/diff.md | 15 +- docs/source/mr/for.md | 15 +- docs/source/mr/help.md | 10 +- docs/source/mr/index.md | 13 +- docs/source/mr/issues.md | 11 +- docs/source/mr/list.md | 27 +- docs/source/mr/merge.md | 13 +- docs/source/mr/note.md | 7 +- docs/source/mr/rebase.md | 13 +- docs/source/mr/reopen.md | 13 +- docs/source/mr/revoke.md | 17 +- docs/source/mr/subscribe.md | 13 +- docs/source/mr/todo.md | 5 +- docs/source/mr/unsubscribe.md | 13 +- docs/source/mr/update.md | 13 +- docs/source/mr/view.md | 7 +- docs/source/release/create.md | 32 +- docs/source/release/delete.md | 10 +- docs/source/release/download.md | 8 +- docs/source/release/help.md | 10 +- docs/source/release/index.md | 7 +- docs/source/release/list.md | 5 +- docs/source/release/upload.md | 24 +- docs/source/release/view.md | 8 +- docs/source/repo/archive.md | 17 +- docs/source/repo/clone.md | 25 +- docs/source/repo/contributors.md | 7 +- docs/source/repo/create.md | 13 +- docs/source/repo/delete.md | 13 +- docs/source/repo/fork.md | 13 +- docs/source/repo/help.md | 10 +- docs/source/repo/index.md | 5 +- docs/source/repo/list.md | 9 +- docs/source/repo/mirror.md | 13 +- docs/source/repo/search.md | 15 +- docs/source/repo/transfer.md | 9 +- docs/source/repo/view.md | 7 +- docs/source/snippet/create.md | 13 +- docs/source/snippet/help.md | 10 +- docs/source/snippet/index.md | 9 +- docs/source/ssh-key/add.md | 8 +- docs/source/ssh-key/get.md | 11 +- docs/source/ssh-key/help.md | 10 +- docs/source/ssh-key/index.md | 13 +- docs/source/ssh-key/list.md | 15 +- docs/source/user/events.md | 7 +- docs/source/user/help.md | 10 +- docs/source/user/index.md | 5 +- docs/source/variable/delete.md | 13 +- docs/source/variable/get.md | 11 +- docs/source/variable/help.md | 10 +- docs/source/variable/index.md | 7 +- docs/source/variable/list.md | 9 +- docs/source/variable/set.md | 21 +- docs/source/variable/update.md | 21 +- docs/source/version/index.md | 5 +- 238 files changed, 3203 insertions(+), 1132 deletions(-) create mode 100644 .markdownlint.yml create mode 100644 .vale.ini create mode 100644 docs/.vale/gitlab/Admin.yml create mode 100644 docs/.vale/gitlab/AlertBoxStyle.yml create mode 100644 docs/.vale/gitlab/BadPlurals.yml create mode 100644 docs/.vale/gitlab/BadgeCapitalization.yml create mode 100644 docs/.vale/gitlab/British.yml create mode 100644 docs/.vale/gitlab/CIConfigFile.yml create mode 100644 docs/.vale/gitlab/CodeblockFences.yml create mode 100644 docs/.vale/gitlab/CurlStringsQuoted.yml create mode 100644 docs/.vale/gitlab/CurrentStatus.yml create mode 100644 docs/.vale/gitlab/DefaultBranch.yml create mode 100644 docs/.vale/gitlab/Dropdown.yml create mode 100644 docs/.vale/gitlab/EOLWhitespace.yml create mode 100644 docs/.vale/gitlab/ElementDescriptors.yml create mode 100644 docs/.vale/gitlab/FirstPerson.yml create mode 100644 docs/.vale/gitlab/FutureTense.yml create mode 100644 docs/.vale/gitlab/HeadingContent.yml create mode 100644 docs/.vale/gitlab/HeadingDepth.yml create mode 100644 docs/.vale/gitlab/InclusionAbleism.yml create mode 100644 docs/.vale/gitlab/InclusionCultural.yml create mode 100644 docs/.vale/gitlab/InclusionGender.yml create mode 100644 docs/.vale/gitlab/InternalLinkCase.yml create mode 100644 docs/.vale/gitlab/InternalLinkExtension.yml create mode 100644 docs/.vale/gitlab/InternalLinkFormat.yml create mode 100644 docs/.vale/gitlab/LatinTerms.yml create mode 100644 docs/.vale/gitlab/Markdown_emoji.yml create mode 100644 docs/.vale/gitlab/MeaningfulLinkWords.yml create mode 100644 docs/.vale/gitlab/MergeConflictMarkers.yml create mode 100644 docs/.vale/gitlab/MultiLineLinks.yml create mode 100644 docs/.vale/gitlab/NonStandardQuotes.yml create mode 100644 docs/.vale/gitlab/OutdatedVersions.yml create mode 100644 docs/.vale/gitlab/OxfordComma.yml create mode 100644 docs/.vale/gitlab/Possessive.yml create mode 100644 docs/.vale/gitlab/ReadingLevel.yml create mode 100644 docs/.vale/gitlab/ReferenceLinks.yml create mode 100644 docs/.vale/gitlab/RelativeLinks.yml create mode 100644 docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml create mode 100644 docs/.vale/gitlab/Repetition.yml create mode 100644 docs/.vale/gitlab/SentenceLength.yml create mode 100644 docs/.vale/gitlab/SentenceSpacing.yml create mode 100644 docs/.vale/gitlab/Simplicity.yml create mode 100644 docs/.vale/gitlab/Spelling.yml create mode 100644 docs/.vale/gitlab/SubstitutionSuggestions.yml create mode 100644 docs/.vale/gitlab/SubstitutionWarning.yml create mode 100644 docs/.vale/gitlab/Substitutions.yml create mode 100644 docs/.vale/gitlab/ToDo.yml create mode 100644 docs/.vale/gitlab/UnclearAntecedent.yml create mode 100644 docs/.vale/gitlab/Uppercase.yml create mode 100644 docs/.vale/gitlab/VersionText.yml create mode 100644 docs/.vale/gitlab/VersionTextSingleLine.yml create mode 100644 docs/.vale/gitlab/Wordy.yml create mode 100644 docs/.vale/gitlab/spelling-exceptions.txt create mode 100644 docs/.vale/vale.tmpl diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index d0d34460..45767f0f 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -16,6 +16,7 @@ default: image: golang:1.18 stages: + - review-docs - test - release @@ -37,6 +38,15 @@ include: cache: paths: - .go/pkg/mod/ + +check_docs_markdown: + image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.16-vale-2.20.1-markdownlint-0.32.2 + stage: review-docs + script: + # Lint prose + - vale --minAlertLevel error docs README.md + # Lint Markdown + - markdownlint --config .markdownlint.yml 'docs/**/*.md' README.md code_navigation: stage: test diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 00000000..2e84c7c1 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,153 @@ +--- +# Base Markdownlint configuration +# Extended Markdownlint configuration in doc/.markdownlint/ +default: true +first-header-h1: true +header-style: + style: "atx" +ul-style: + style: "dash" +no-trailing-spaces: false +line-length: false +no-duplicate-header: + allow_different_nesting: true +no-trailing-punctuation: + punctuation: ".,;:!。，；：！？" +ol-prefix: + style: "one" +no-inline-html: false +hr-style: + style: "---" +no-emphasis-as-heading: false +first-line-h1: false +code-block-style: + style: "fenced" +emphasis-style: false +link-fragments: false +reference-links-images: false +proper-names: + names: [ + "Akismet", + "Alertmanager", + "AlmaLinux", + "API", + "Asana", + "Auth0", + "Authentiq", + "Azure", + "Bamboo", + "Bitbucket", + "Bugzilla", + "CAS", + "CentOS", + "Consul", + "Debian", + "DevOps", + "Docker", + "DockerSlim", + "Elasticsearch", + "Facebook", + "fastlane", + "fluent-plugin-redis-slowlog", + "GDK", + "Geo", + "Git LFS", + "git-annex", + "git-credential", + "git-sizer", + "Git", + "Gitaly", + "GitHub", + "GitLab Geo", + "GitLab Monitor", + "GitLab Operator", + "GitLab Pages", + "GitLab Rails", + "GitLab Runner", + "GitLab Shell", + "GitLab Workhorse", + "GitLab", + "Gitleaks", + "Gmail", + "Google", + "Grafana", + "Gzip", + "Helm", + "HipChat", + "ID", + "Ingress", + "jasmine-jquery", + "JavaScript", + "Jaeger", + "Jenkins", + "Jira", + "Jira Cloud", + "Jira Server", + "jQuery", + "JSON", + "JupyterHub", + "Karma", + "Kerberos", + "Knative", + "Kubernetes", + "LDAP", + "Let's Encrypt", + "Markdown", + "markdownlint", + "Mattermost", + "Microsoft", + "minikube", + "MinIO", + "ModSecurity", + "NGINX Ingress", + "NGINX", + "OAuth", + "OAuth 2", + "OmniAuth", + "Omnibus GitLab", + "OpenID", + "OpenShift", + "PgBouncer", + "Postfix", + "PostgreSQL", + "Praefect", + "Prometheus", + "Puma", + "puma-worker-killer", + "Python", + "Rake", + "Redis", + "Redmine", + "reCAPTCHA", + "Ruby", + "runit", + "Salesforce", + "SAML", + "Sendmail", + "Sentry", + "Service Desk", + "Sidekiq", + "Shibboleth", + "Slack", + "SMTP", + "SpotBugs", + "ssh-key", + "SSH", + "Tiller", + "TOML", + "Trello", + "Trello Power-Ups", + "TypeScript", + "Twitter", + "Ubuntu", + "Ultra Auth", + "Unicorn", + "unicorn-worker-killer", + "URL", + "WebdriverIO", + "Workload Identity Pool", + "Workload Identity Provider", + "YAML", + "YouTrack" + ] + code_blocks: false diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 00000000..c60ecc45 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,12 @@ +# Vale configuration file. +# +# For more information, see https://errata-ai.gitbook.io/vale/getting-started/configuration. + +StylesPath = docs/.vale +MinAlertLevel = suggestion + +[*.md] +BasedOnStyles = gitlab + +# Ignore SVG markup +TokenIgnores = (\*\*\{\w*\}\*\*) diff --git a/README.md b/README.md index 6e01b8d2..7f006c56 100644 --- a/README.md +++ b/README.md @@ -15,38 +15,38 @@ GLab is an open source GitLab CLI tool bringing GitLab to your terminal next to ## Table of contents -* [Usage](#usage) -* [Demo](#demo) -* [Documentation](#documentation) -* [Installation](#installation) - * [Quick Install](#quick-install) - * [Windows](#windows) - * [WinGet](#winget) - * [Scoop](#scoop) - * [EXE Installer](#exe-installer) - * [Linux](#linux) - * [Linuxbrew (Homebrew)](#linuxbrew-homebrew) - * [Snapcraft](#snapcraft) - * [Arch Linux](#arch-linux) - * [KISS Linux](#kiss-linux) - * [Alpine Linux](#alpine-linux) - * [Install a pinned version from edge](#install-a-pinned-version-from-edge) - * [Alpine Linux Docker-way](#alpine-linux-docker-way) - * [Nix/NixOS](#nixnixos) - * [MPR (Debian/Ubuntu)](#mpr-debianubuntu) - * [Prebuilt-MPR](#prebuilt-mpr) - * [Spack](#spack) - * [macOS](#macos) - * [Homebrew](#homebrew) - * [MacPorts](#macports) - * [Building From Source](#building-from-source) - * [Prerequisites](#prerequisites-for-building-from-source-are) -* [Authentication](#authentication) -* [Configuration](#configuration) -* [Environment Variables](#environment-variables) -* [What about lab](#what-about-lab) -* [Issues](#issues) -* [Contributing](#contributing) +- [Usage](#usage) +- [Demo](#demo) +- [Documentation](#documentation) +- [Installation](#installation) + - [Quick Install](#quick-install) + - [Windows](#windows) + - [WinGet](#winget) + - [Scoop](#scoop) + - [EXE Installer](#exe-installer) + - [Linux](#linux) + - [Linuxbrew (Homebrew)](#linuxbrew-homebrew) + - [Snapcraft](#snapcraft) + - [Arch Linux](#arch-linux) + - [KISS Linux](#kiss-linux) + - [Alpine Linux](#alpine-linux) + - [Install a pinned version from edge](#install-a-pinned-version-from-edge) + - [Alpine Linux Docker-way](#alpine-linux-docker-way) + - [Nix/NixOS](#nixnixos) + - [MPR (Debian/Ubuntu)](#mpr-debianubuntu) + - [Prebuilt-MPR](#prebuilt-mpr) + - [Spack](#spack) + - [macOS](#macos) + - [Homebrew](#homebrew) + - [MacPorts](#macports) + - [Building From Source](#building-from-source) + - [Prerequisites](#prerequisites-for-building-from-source-are) +- [Authentication](#authentication) +- [Configuration](#configuration) +- [Environment Variables](#environment-variables) +- [What about lab](#what-about-lab) +- [Issues](#issues) +- [Contributing](#contributing) ## Usage @@ -85,7 +85,7 @@ brew upgrade glab Alternatively, you can install `glab` by shell script: ```shell -curl -s https://gitlab.com/gitlab-org/cli/-/raw/main/scripts/install.sh | sudo sh +curl -s "https://gitlab.com/gitlab-org/cli/-/raw/main/scripts/install.sh" | sudo sh ``` *Installs into `usr/bin`* @@ -146,7 +146,7 @@ brew upgrade glab 1. Make sure you have [snap installed on your Linux distribution](https://snapcraft.io/docs/installing-snapd). 1. `sudo snap install --edge glab` -1. `sudo snap connect glab:ssh-keys` to grant ssh access +1. `sudo snap connect glab:ssh-keys` to grant SSH access #### Arch Linux @@ -158,7 +158,8 @@ pacman -S glab #### KISS Linux -> WARNING: It seems that KISS Linux may no longer be actively maintained, so links to its web domain have been removed from this README. +WARNING: +It seems that KISS Linux may no longer be actively maintained, so links to its web domain have been removed from this README. `glab` is available on the [KISS Linux Community Repository](https://github.com/kisslinux/community) as `gitlab-glab`. If you already have the community repository configured in your `KISS_PATH` you can install `glab` through your terminal. @@ -285,8 +286,8 @@ If a supported binary for your OS is not found at the [releases page](https://gi #### Prerequisites for building from source -* `make` -* Go 1.13+ +- `make` +- Go 1.13+ 1. Verify that you have Go 1.13+ installed @@ -322,25 +323,25 @@ If a supported binary for your OS is not found at the [releases page](https://gi Get a GitLab access token at or if self-managed: -* Start interactive setup: +- Start interactive setup: ```shell glab auth login ``` -* Authenticate against `gitlab.com` by reading the token from a file: +- Authenticate against `gitlab.com` by reading the token from a file: ```shell glab auth login --stdin < myaccesstoken.txt ``` -* Authenticate against a self-managed GitLab instance by reading from a file: +- Authenticate against a self-managed GitLab instance by reading from a file: ```shell glab auth login --hostname salsa.debian.org --stdin < myaccesstoken.txt ``` -* Authenticate with token and hostname. Not recommended for shared environments: +- Authenticate with token and hostname. Not recommended for shared environments: ```shell glab auth login --hostname gitlab.example.org --token xxxxx @@ -350,23 +351,23 @@ Get a GitLab access token at " + "\n\n") - buf.WriteString("# " + name + "\n\n") - buf.WriteString(cmd.Short + "\n\n") + buf.WriteString("# `" + name + "`\n\n") + buf.WriteString(cmd.Short + "\n") if len(cmd.Long) > 0 { - buf.WriteString("## Synopsis\n\n") - buf.WriteString(cmd.Long + "\n\n") + // Skipping `help` commands until Long description can be revised + if cmd.Name() != "help" { + buf.WriteString("\n## Synopsis\n\n") + buf.WriteString(cmd.Long) + } } if cmd.Runnable() { - buf.WriteString(fmt.Sprintf("```plaintext\n%s\n```\n\n", cmd.UseLine())) + buf.WriteString(fmt.Sprintf("\n```plaintext\n%s\n```\n", cmd.UseLine())) } if len(cmd.Example) > 0 { - buf.WriteString("## Examples\n\n") - buf.WriteString(fmt.Sprintf("```plaintext\n%s\n```\n\n", cmd.Example)) + buf.WriteString("\n## Examples\n\n") + buf.WriteString(fmt.Sprintf("```plaintext\n%s\n```\n", cmd.Example)) } if err := printOptions(buf, cmd, name); err != nil { @@ -212,17 +214,17 @@ func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error { flags := cmd.NonInheritedFlags() flags.SetOutput(buf) if flags.HasAvailableFlags() { - buf.WriteString("### Options\n\n```plaintext\n") + buf.WriteString("\n## Options\n\n```plaintext\n") flags.PrintDefaults() - buf.WriteString("```\n\n") + buf.WriteString("```\n") } parentFlags := cmd.InheritedFlags() parentFlags.SetOutput(buf) if parentFlags.HasAvailableFlags() { - buf.WriteString("### Options inherited from parent commands\n\n```plaintext\n") + buf.WriteString("\n## Options inherited from parent commands\n\n```plaintext\n") parentFlags.PrintDefaults() - buf.WriteString("```\n\n") + buf.WriteString("```\n") } return nil } diff --git a/commands/alias/set/alias_set.go b/commands/alias/set/alias_set.go index e2622160..d2647fbb 100644 --- a/commands/alias/set/alias_set.go +++ b/commands/alias/set/alias_set.go @@ -44,7 +44,7 @@ func NewCmdSet(f *cmdutils.Factory, runF func(*SetOptions) error) *cobra.Command arguments, you must explicitly accept them using "$1", "$2", etc., or "$@" to accept all of them. Platform note: on Windows, shell aliases are executed via "sh" as installed by Git For Windows. If - you have installed git on Windows in some other way, shell aliases may not work for you. + you have installed Git on Windows in some other way, shell aliases may not work for you. Quotes must always be used when defining a command as in the examples. `), Example: heredoc.Doc(` diff --git a/commands/api/api.go b/commands/api/api.go index a3757c2a..d3ad1f67 100644 --- a/commands/api/api.go +++ b/commands/api/api.go @@ -61,47 +61,50 @@ func NewCmdApi(f *cmdutils.Factory, runF func(*ApiOptions) error) *cobra.Command cmd := &cobra.Command{ Use: "api ", Short: "Make an authenticated request to GitLab API", - Long: `Makes an authenticated HTTP request to the GitLab API and prints the response. -The endpoint argument should either be a path of a GitLab API v4 endpoint, or -"graphql" to access the GitLab's GraphQL API. + Long: heredoc.Docf(` + Makes an authenticated HTTP request to the GitLab API and prints the response. + The endpoint argument should either be a path of a GitLab API v4 endpoint, or + "graphql" to access the GitLab GraphQL API. -GitLab REST API Docs: https://docs.gitlab.com/ce/api/README.html -GitLab GraphQL Docs: https://docs.gitlab.com/ee/api/graphql/ + - [GitLab REST API Docs](https://docs.gitlab.com/ee/api/index.html) + - [GitLab GraphQL Docs](https://docs.gitlab.com/ee/api/graphql/) -If the current directory is a git directory, the GitLab authenticated host in the current git -directory will be used else gitlab.com will be used. -Override the GitLab hostname with '--hostname'. + If the current directory is a Git directory, the GitLab authenticated host in the current + directory will be used otherwise %[1]sgitlab.com%[1]s will be used. + Override the GitLab hostname with '--hostname'. -Placeholder values ":fullpath" or ":id"", ":user" or ":username", ":group", ":namespace", -":repo", and ":branch" in the endpoint argument will get replaced with values from the -repository of the current directory. + Placeholder values %[1]s:fullpath%[1]s or %[1]s:id%[1]s, %[1]s:user%[1]s or %[1]s:username%[1]s, %[1]s:group%[1]s, %[1]s:namespace%[1]s, + %[1]s:repo%[1]s, and %[1]s:branch%[1]s in the endpoint argument will get replaced with values from the + repository of the current directory. -The default HTTP request method is "GET" normally and "POST" if any parameters -were added. Override the method with '--method'. + The default HTTP request method is "GET" normally and "POST" if any parameters + were added. Override the method with '--method'. -Pass one or more '--raw-field' values in "key=value" format to add -JSON-encoded string parameters to the POST body. + Pass one or more '--raw-field' values in "key=value" format to add + JSON-encoded string parameters to the POST body. -The '--field' flag behaves like '--raw-field' with magic type conversion based -on the format of the value: -- literal values "true", "false", "null", and integer numbers get converted to - appropriate JSON types; -- placeholder values ":namespace", ":repo", and ":branch" get populated with values - from the repository of the current directory; -- if the value starts with "@", the rest of the value is interpreted as a - filename to read the value from. Pass "-" to read from standard input. + The '--field' flag behaves like '--raw-field' with magic type conversion based + on the format of the value: -For GraphQL requests, all fields other than "query" and "operationName" are -interpreted as GraphQL variables. + - literal values "true", "false", "null", and integer numbers get converted to + appropriate JSON types; + - placeholder values ":namespace", ":repo", and ":branch" get populated with values + from the repository of the current directory; + - if the value starts with "@", the rest of the value is interpreted as a + filename to read the value from. Pass "-" to read from standard input. -Raw request body may be passed from the outside via a file specified by '--input'. -Pass "-" to read from standard input. In this mode, parameters specified via -'--field' flags are serialized into URL query parameters. + For GraphQL requests, all fields other than "query" and "operationName" are + interpreted as GraphQL variables. -In '--paginate' mode, all pages of results will sequentially be requested until -there are no more pages of results. For GraphQL requests, this requires that the -original query accepts an '$endCursor: String' variable and that it fetches the -'pageInfo{ hasNextPage, endCursor }' set of fields from a collection.`, + Raw request body may be passed from the outside via a file specified by '--input'. + Pass "-" to read from standard input. In this mode, parameters specified via + '--field' flags are serialized into URL query parameters. + + In '--paginate' mode, all pages of results will sequentially be requested until + there are no more pages of results. For GraphQL requests, this requires that the + original query accepts an '$endCursor: String' variable and that it fetches the + 'pageInfo{ hasNextPage, endCursor }' set of fields from a collection. + `,"`"), Example: heredoc.Doc(` $ glab api projects/:fullpath/releases diff --git a/commands/auth/login/helper.go b/commands/auth/login/helper.go index 7d3df5ee..b141c931 100644 --- a/commands/auth/login/helper.go +++ b/commands/auth/login/helper.go @@ -36,7 +36,7 @@ func NewCmdCredential(f *cmdutils.Factory, runF func(*CredentialOptions) error) cmd := &cobra.Command{ Use: "git-credential", Args: cobra.ExactArgs(1), - Short: "Implements git credential helper manager", + Short: "Implements Git credential helper manager", Hidden: true, RunE: func(cmd *cobra.Command, args []string) error { opts.Operation = args[0] diff --git a/commands/auth/login/login.go b/commands/auth/login/login.go index 8235acd5..3464c900 100644 --- a/commands/auth/login/login.go +++ b/commands/auth/login/login.go @@ -48,16 +48,16 @@ func NewCmdLogin(f *cmdutils.Factory) *cobra.Command { Long: heredoc.Docf(` Authenticate with a GitLab instance. You can pass in a token on standard input by using %[1]s--stdin%[1]s. - The minimum required scopes for the token are: "api", "write_repository". + The minimum required scopes for the token are: %[1]sapi%[1]s, %[1]swrite_repository%[1]s. `, "`"), - Example: heredoc.Doc(` + Example: heredoc.Docf(` # start interactive setup $ glab auth login - # authenticate against gitlab.com by reading the token from a file + # authenticate against %[1]sgitlab.com%[1]s by reading the token from a file $ glab auth login --stdin < myaccesstoken.txt # authenticate with a self-hosted GitLab instance $ glab auth login --hostname salsa.debian.org - `), + `, "`"), RunE: func(cmd *cobra.Command, args []string) error { if !opts.IO.PromptEnabled() && !tokenStdin && opts.Token == "" { return &cmdutils.FlagError{Err: errors.New("--stdin or --token required when not running interactively")} diff --git a/commands/ci/artifact/artifact.go b/commands/ci/artifact/artifact.go index 6693f817..b18e9494 100644 --- a/commands/ci/artifact/artifact.go +++ b/commands/ci/artifact/artifact.go @@ -18,8 +18,8 @@ func NewCmdRun(f *cmdutils.Factory) *cobra.Command { Short: `Download all Artifacts from the last pipeline`, Aliases: []string{"push"}, Example: heredoc.Doc(` - $ glab ci artifact main build - $ glab ci artifact main deploy --path="artifacts/" + glab ci artifact main build + glab ci artifact main deploy --path="artifacts/" `), Long: ``, Args: cobra.ExactArgs(2), diff --git a/commands/ci/delete/delete.go b/commands/ci/delete/delete.go index a29eb25f..98ef93be 100644 --- a/commands/ci/delete/delete.go +++ b/commands/ci/delete/delete.go @@ -19,8 +19,8 @@ func NewCmdDelete(f *cmdutils.Factory) *cobra.Command { Use: "delete [flags]", Short: `Delete a CI pipeline`, Example: heredoc.Doc(` - $ glab ci delete 34 - $ glab ci delete 12,34,2 + glab ci delete 34 + glab ci delete 12,34,2 `), Long: ``, Args: cobra.ExactArgs(1), diff --git a/commands/ci/legacyci/pipeline_ci.go b/commands/ci/legacyci/pipeline_ci.go index acc40b77..69dc4224 100644 --- a/commands/ci/legacyci/pipeline_ci.go +++ b/commands/ci/legacyci/pipeline_ci.go @@ -18,7 +18,7 @@ func NewCmdCI(f *cmdutils.Factory) *cobra.Command { Use: "ci [flags]", Short: `Work with GitLab CI pipelines and jobs`, Example: heredoc.Doc(` - $ glab pipeline ci trace + glab pipeline ci trace `), } diff --git a/commands/ci/lint/lint.go b/commands/ci/lint/lint.go index 2567a457..eaacb987 100644 --- a/commands/ci/lint/lint.go +++ b/commands/ci/lint/lint.go @@ -19,7 +19,7 @@ import ( func NewCmdLint(f *cmdutils.Factory) *cobra.Command { var pipelineCILintCmd = &cobra.Command{ Use: "lint", - Short: "Checks if your .gitlab-ci.yml file is valid.", + Short: "Checks if your `.gitlab-ci.yml` file is valid.", Args: cobra.MaximumNArgs(1), Example: heredoc.Doc(` $ glab ci lint diff --git a/commands/ci/list/list.go b/commands/ci/list/list.go index 75c9c93e..3e42ec2a 100644 --- a/commands/ci/list/list.go +++ b/commands/ci/list/list.go @@ -18,8 +18,8 @@ func NewCmdList(f *cmdutils.Factory) *cobra.Command { Use: "list [flags]", Short: `Get the list of CI pipelines`, Example: heredoc.Doc(` - $ glab ci list - $ glab ci list --status=failed + glab ci list + glab ci list --status=failed `), Long: ``, Args: cobra.ExactArgs(0), diff --git a/commands/ci/retry/retry.go b/commands/ci/retry/retry.go index 934d1033..4328550a 100644 --- a/commands/ci/retry/retry.go +++ b/commands/ci/retry/retry.go @@ -17,7 +17,7 @@ func NewCmdRetry(f *cmdutils.Factory) *cobra.Command { Short: `Retry a CI job`, Aliases: []string{}, Example: heredoc.Doc(` - $ glab ci retry 871528 + glab ci retry 871528 `), Long: ``, Args: cobra.ExactArgs(1), diff --git a/commands/ci/run/run.go b/commands/ci/run/run.go index ffe0301e..75614ad2 100644 --- a/commands/ci/run/run.go +++ b/commands/ci/run/run.go @@ -45,10 +45,10 @@ func NewCmdRun(f *cmdutils.Factory) *cobra.Command { Short: `Create or run a new CI pipeline`, Aliases: []string{"create"}, Example: heredoc.Doc(` - $ glab ci run - $ glab ci run -b main - $ glab ci run -b main --variables MYKEY:some_value - $ glab ci run -b main --variables MYKEY:some_value --variables KEY2:another_value + glab ci run + glab ci run -b main + glab ci run -b main --variables MYKEY:some_value + glab ci run -b main --variables MYKEY:some_value --variables KEY2:another_value `), Long: ``, Args: cobra.ExactArgs(0), diff --git a/commands/ci/status/status.go b/commands/ci/status/status.go index f25fe865..f4bc5dde 100644 --- a/commands/ci/status/status.go +++ b/commands/ci/status/status.go @@ -22,10 +22,10 @@ func NewCmdStatus(f *cmdutils.Factory) *cobra.Command { Short: `View a running CI pipeline on current or other branch specified`, Aliases: []string{"stats"}, Example: heredoc.Doc(` - $ glab ci status --live - $ glab ci status --compact // more compact view - $ glab ci status --branch=master // Get pipeline for master branch - $ glab ci status // Get pipeline for current branch + glab ci status --live + glab ci status --compact // more compact view + glab ci status --branch=master // Get pipeline for master branch + glab ci status // Get pipeline for current branch `), Long: ``, Args: cobra.ExactArgs(0), diff --git a/commands/ci/view/view.go b/commands/ci/view/view.go index 120220d2..a282a17d 100644 --- a/commands/ci/view/view.go +++ b/commands/ci/view/view.go @@ -50,13 +50,13 @@ func NewCmdView(f *cmdutils.Factory) *cobra.Command { 'Ctrl+C' to cancel job -- (Quits CI view if selected job isn't running or pending). 'Ctrl+Q' to Quit CI View. 'Ctrl+Space' suspend application and view logs (similar to glab pipeline ci trace) - Supports vi style (hjkl,Gg) bindings and arrow keys for navigating jobs and logs. + Supports vi style bindings and arrow keys for navigating jobs and logs. `), Example: heredoc.Doc(` - $ glab pipeline ci view # Uses current branch - $ glab pipeline ci view master # Get latest pipeline on master branch - $ glab pipeline ci view -b master # just like the second example - $ glab pipeline ci view -b master -R profclems/glab # Get latest pipeline on master branch of profclems/glab repo + glab pipeline ci view # Uses current branch + glab pipeline ci view master # Get latest pipeline on master branch + glab pipeline ci view -b master # just like the second example + glab pipeline ci view -b master -R profclems/glab # Get latest pipeline on master branch of profclems/glab repo `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/completion/completion.go b/commands/completion/completion.go index 6d25bb53..a7eeabb8 100644 --- a/commands/completion/completion.go +++ b/commands/completion/completion.go @@ -3,6 +3,7 @@ package completion import ( "fmt" + "github.com/MakeNowJust/heredoc" "gitlab.com/gitlab-org/cli/pkg/iostreams" "github.com/spf13/cobra" @@ -19,27 +20,33 @@ func NewCmdCompletion(io *iostreams.IOStreams) *cobra.Command { var completionCmd = &cobra.Command{ Use: "completion", Short: "Generate shell completion scripts", - Long: `Generate shell completion scripts for glab commands. + Long: heredoc.Docf(` + The output of this command will be computer code and is meant to be saved + to a file or immediately evaluated by an interactive shell. + + For example, for bash you could add this to your %[1]s~/.bash_profile%[1]s: + + %[2]splaintext + eval "$(glab completion -s bash)" + %[2]s -The output of this command will be computer code and is meant to be saved to a -file or immediately evaluated by an interactive shell. + Generate a %[1]s_glab%[1]s completion script and put it somewhere in your %[1]s$fpath%[1]s: -For example, for bash you could add this to your '~/.bash_profile': + %[2]splaintext + glab completion -s zsh > /usr/local/share/zsh/site-functions/_glab + %[2]s - eval "$(glab completion -s bash)" + Ensure that the following is present in your %[1]s~/.zshrc%[1]s: -Generate a %[1]s_glab%[1]s completion script and put it somewhere in your %[1]s$fpath%[1]s: - glab completion -s zsh > /usr/local/share/zsh/site-functions/_glab - Ensure that the following is present in your %[1]s~/.zshrc%[1]s: - autoload -U compinit - compinit -i - - Zsh version 5.7 or later is recommended. + - %[1]sautoload -U compinit%[1]s + - %[1]scompinit -i%[1]s -When installing glab through a package manager, however, it's possible that -no additional shell configuration is necessary to gain completion support. -For Homebrew, see -`, + Zsh version 5.7 or later is recommended. + + When installing glab through a package manager, however, it's possible that + no additional shell configuration is necessary to gain completion support. + For Homebrew, see + `, "`", "```"), RunE: func(cmd *cobra.Command, args []string) error { out := io.StdOut rootCmd := cmd.Parent() diff --git a/commands/config/config.go b/commands/config/config.go index 6219252f..29159fd4 100644 --- a/commands/config/config.go +++ b/commands/config/config.go @@ -17,18 +17,18 @@ func NewCmdConfig(f *cmdutils.Factory) *cobra.Command { configCmd := &cobra.Command{ Use: "config [flags]", Short: `Set and get glab settings`, - Long: heredoc.Doc(`Get and set key/value strings. + Long: heredoc.Docf(`Get and set key/value strings. Current respected settings: -- token: Your gitlab access token, defaults to environment variables -- gitlab_uri: if unset, defaults to https://gitlab.com +- token: Your GitLab access token, defaults to environment variables +- gitlab_uri: if unset, defaults to %[1]shttps://gitlab.com%[1]s - browser: if unset, defaults to environment variables - editor: if unset, defaults to environment variables. - visual: alternative for editor. if unset, defaults to environment variables. -- glamour_style: Your desired markdown renderer style. Options are dark, light, notty. Custom styles are allowed set a custom style https://github.com/charmbracelet/glamour#styles +- glamour_style: Your desired Markdown renderer style. Options are dark, light, notty. Custom styles are allowed using [glamour](https://github.com/charmbracelet/glamour#styles) - glab_pager: Your desired pager command to use (e.g. less -R) - `), +`, "`"), Aliases: []string{"conf"}, } @@ -49,8 +49,8 @@ func NewCmdConfigGet(f *cmdutils.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "get ", - Short: "Prints the value of a given configuration key", - Long: `Get the value for a given configuration key.`, + Short: "Prints the value of a given configuration key.", + Long: ``, Example: ` $ glab config get editor vim @@ -93,8 +93,8 @@ Use glab config set --global if you want to set a global config. Specifying the --hostname flag also saves in the global config file `, Example: ` - $ glab config set editor vim - $ glab config set token xxxxx -h gitlab.com + glab config set editor vim + glab config set token xxxxx -h gitlab.com `, Args: cobra.ExactArgs(2), RunE: func(cmd *cobra.Command, args []string) error { @@ -138,11 +138,16 @@ func NewCmdConfigInit(f *cmdutils.Factory) *cobra.Command { configInitCmd := &cobra.Command{ Use: "init", Short: "Shows a prompt to set basic glab configuration", - Long: `Update the configuration by setting a key to a value. -Examples: - $ glab config init - ? Enter default Gitlab Host (Current Value: https://gitlab.com): | -`, + Long: heredoc.Docf(` + Update the configuration by setting a key to a value. + + Examples: + + %[1]splaintext + $ glab config init + ? Enter default GitLab Host (Current Value: https://gitlab.com): + %[1]s +`,"```"), RunE: func(cmd *cobra.Command, args []string) error { return configInit(f) }, diff --git a/commands/issue/close/issue_close.go b/commands/issue/close/issue_close.go index 14898ee6..9aafa7fa 100644 --- a/commands/issue/close/issue_close.go +++ b/commands/issue/close/issue_close.go @@ -18,8 +18,8 @@ func NewCmdClose(f *cmdutils.Factory) *cobra.Command { Short: `Close an issue`, Long: ``, Example: heredoc.Doc(` - $ glab issue close 123 - $ glab issue close https://gitlab.com/profclems/glab/-/issues/123 + glab issue close 123 + glab issue close https://gitlab.com/profclems/glab/-/issues/123 `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/create/issue_create.go b/commands/issue/create/issue_create.go index 82fac44e..37d6eb22 100644 --- a/commands/issue/create/issue_create.go +++ b/commands/issue/create/issue_create.go @@ -67,11 +67,11 @@ func NewCmdCreate(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"new"}, Example: heredoc.Doc(` - $ glab issue create - $ glab issue new - $ glab issue create -m release-2.0.0 -t "we need this feature" --label important - $ glab issue new -t "Fix CVE-YYYY-XXXX" -l security --linked-mr 123 - $ glab issue create -m release-1.0.1 -t "security fix" --label security --web + glab issue create + glab issue new + glab issue create -m release-2.0.0 -t "we need this feature" --label important + glab issue new -t "Fix CVE-YYYY-XXXX" -l security --linked-mr 123 + glab issue create -m release-1.0.1 -t "security fix" --label security --web `), Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/delete/issue_delete.go b/commands/issue/delete/issue_delete.go index ddd42eec..a48a0e44 100644 --- a/commands/issue/delete/issue_delete.go +++ b/commands/issue/delete/issue_delete.go @@ -18,9 +18,9 @@ func NewCmdDelete(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"del"}, Example: heredoc.Doc(` - $ glab issue delete 123 - $ glab issue del 123 - $ glab issue delete https://gitlab.com/profclems/glab/-/issues/123 + glab issue delete 123 + glab issue del 123 + glab issue delete https://gitlab.com/profclems/glab/-/issues/123 `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/issue.go b/commands/issue/issue.go index fe8bb0dd..15354cbb 100644 --- a/commands/issue/issue.go +++ b/commands/issue/issue.go @@ -24,10 +24,10 @@ func NewCmdIssue(f *cmdutils.Factory) *cobra.Command { Short: `Work with GitLab issues`, Long: ``, Example: heredoc.Doc(` - $ glab issue list - $ glab issue create --label --confidential - $ glab issue view --web - $ glab issue note -m "closing because !123 was merged" + glab issue list + glab issue create --label --confidential + glab issue view --web + glab issue note -m "closing because !123 was merged" `), Annotations: map[string]string{ "help:arguments": heredoc.Doc(` diff --git a/commands/issue/list/issue_list.go b/commands/issue/list/issue_list.go index 0c1a82bc..fd6ae74f 100644 --- a/commands/issue/list/issue_list.go +++ b/commands/issue/list/issue_list.go @@ -65,10 +65,10 @@ func NewCmdList(f *cmdutils.Factory, runE func(opts *ListOptions) error) *cobra. Long: ``, Aliases: []string{"ls"}, Example: heredoc.Doc(` - $ glab issue list --all - $ glab issue ls --all - $ glab issue list --mine - $ glab issue list --milestone release-2.0.0 --opened + glab issue list --all + glab issue ls --all + glab issue list --mine + glab issue list --milestone release-2.0.0 --opened `), Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/reopen/issue_reopen.go b/commands/issue/reopen/issue_reopen.go index 79991698..5cc3927c 100644 --- a/commands/issue/reopen/issue_reopen.go +++ b/commands/issue/reopen/issue_reopen.go @@ -19,9 +19,9 @@ func NewCmdReopen(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"open"}, Example: heredoc.Doc(` - $ glab issue reopen 123 - $ glab issue open 123 - $ glab issue reopen https://gitlab.com/profclems/glab/-/issues/123 + glab issue reopen 123 + glab issue open 123 + glab issue reopen https://gitlab.com/profclems/glab/-/issues/123 `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/subscribe/issue_subscribe.go b/commands/issue/subscribe/issue_subscribe.go index d520341c..4cb95edf 100644 --- a/commands/issue/subscribe/issue_subscribe.go +++ b/commands/issue/subscribe/issue_subscribe.go @@ -17,9 +17,9 @@ func NewCmdSubscribe(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"sub"}, Example: heredoc.Doc(` - $ glab issue subscribe 123 - $ glab issue sub 123 - $ glab issue subscribe https://gitlab.com/profclems/glab/-/issues/123 + glab issue subscribe 123 + glab issue sub 123 + glab issue subscribe https://gitlab.com/profclems/glab/-/issues/123 `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/unsubscribe/issue_unsubscribe.go b/commands/issue/unsubscribe/issue_unsubscribe.go index acf10d70..aa24ecd9 100644 --- a/commands/issue/unsubscribe/issue_unsubscribe.go +++ b/commands/issue/unsubscribe/issue_unsubscribe.go @@ -18,9 +18,9 @@ func NewCmdUnsubscribe(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"unsub"}, Example: heredoc.Doc(` - $ glab issue unsubscribe 123 - $ glab issue unsub 123 - $ glab issue unsubscribe https://gitlab.com/profclems/glab/-/issues/123 + glab issue unsubscribe 123 + glab issue unsub 123 + glab issue unsubscribe https://gitlab.com/profclems/glab/-/issues/123 `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/update/issue_update.go b/commands/issue/update/issue_update.go index fefaeb1d..2415e78e 100644 --- a/commands/issue/update/issue_update.go +++ b/commands/issue/update/issue_update.go @@ -20,8 +20,8 @@ func NewCmdUpdate(f *cmdutils.Factory) *cobra.Command { Short: `Update issue`, Long: ``, Example: heredoc.Doc(` - $ glab issue update 42 --label ui,ux - $ glab issue update 42 --unlabel working + glab issue update 42 --label ui,ux + glab issue update 42 --unlabel working `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/issue/view/issue_view.go b/commands/issue/view/issue_view.go index 53c1c9e3..dd3b45a2 100644 --- a/commands/issue/view/issue_view.go +++ b/commands/issue/view/issue_view.go @@ -42,11 +42,11 @@ func NewCmdView(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"show"}, Example: heredoc.Doc(` - $ glab issue view 123 - $ glab issue show 123 - $ glab issue view --web 123 - $ glab issue view --comments 123 - $ glab issue view https://gitlab.com/profclems/glab/-/issues/123 + glab issue view 123 + glab issue show 123 + glab issue view --web 123 + glab issue view --comments 123 + glab issue view https://gitlab.com/profclems/glab/-/issues/123 `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/label/create/label_create.go b/commands/label/create/label_create.go index 8d6a8239..b8cdc6d1 100644 --- a/commands/label/create/label_create.go +++ b/commands/label/create/label_create.go @@ -18,9 +18,9 @@ func NewCmdCreate(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"new"}, Example: heredoc.Doc(` - $ glab label create - $ glab label new - $ glab label create -R owner/repo + glab label create + glab label new + glab label create -R owner/repo `), Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/label/list/label_list.go b/commands/label/list/label_list.go index e0672d41..a65d0603 100644 --- a/commands/label/list/label_list.go +++ b/commands/label/list/label_list.go @@ -20,9 +20,9 @@ func NewCmdList(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"ls"}, Example: heredoc.Doc(` - $ glab label list - $ glab label ls - $ glab label list -R owner/repository + glab label list + glab label ls + glab label list -R owner/repository `), Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/approve/mr_approve.go b/commands/mr/approve/mr_approve.go index 09f756cc..56d99630 100644 --- a/commands/mr/approve/mr_approve.go +++ b/commands/mr/approve/mr_approve.go @@ -17,11 +17,11 @@ func NewCmdApprove(f *cmdutils.Factory) *cobra.Command { Short: `Approve merge requests`, Long: ``, Example: heredoc.Doc(` - $ glab mr approve 235 - $ glab mr approve 123 345 - $ glab mr approve branch-1 - $ glab mr approve branch-2 branch-3 - $ glab mr approve # Finds open merge request from current branch + glab mr approve 235 + glab mr approve 123 345 + glab mr approve branch-1 + glab mr approve branch-2 branch-3 + glab mr approve # Finds open merge request from current branch `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/mr/checkout/mr_checkout.go b/commands/mr/checkout/mr_checkout.go index 828c29a6..2b30789e 100644 --- a/commands/mr/checkout/mr_checkout.go +++ b/commands/mr/checkout/mr_checkout.go @@ -29,11 +29,11 @@ func NewCmdCheckout(f *cmdutils.Factory) *cobra.Command { Short: "Checkout to an open merge request", Long: ``, Example: heredoc.Doc(` - $ glab mr checkout 1 - $ glab mr checkout branch --track - $ glab mr checkout 12 --branch todo-fix - $ glab mr checkout new-feature --set-upstream-to=upstream/main - $ glab mr checkout # use checked out branch + glab mr checkout 1 + glab mr checkout branch --track + glab mr checkout 12 --branch todo-fix + glab mr checkout new-feature --set-upstream-to=upstream/main + glab mr checkout # use checked out branch `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/close/mr_close.go b/commands/mr/close/mr_close.go index 9a10d973..eef0cf4d 100644 --- a/commands/mr/close/mr_close.go +++ b/commands/mr/close/mr_close.go @@ -18,12 +18,12 @@ func NewCmdClose(f *cmdutils.Factory) *cobra.Command { Short: `Close merge requests`, Long: ``, Example: heredoc.Doc(` - $ glab mr close 1 - $ glab mr close 1 2 3 4 # close multiple branches at once - $ glab mr close # use checked out branch - $ glab mr close branch - $ glab mr close username:branch - $ glab mr close branch -R another/repo + glab mr close 1 + glab mr close 1 2 3 4 # close multiple branches at once + glab mr close # use checked out branch + glab mr close branch + glab mr close username:branch + glab mr close branch -R another/repo `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/mr/create/mr_create.go b/commands/mr/create/mr_create.go index b603d056..87d8fe05 100644 --- a/commands/mr/create/mr_create.go +++ b/commands/mr/create/mr_create.go @@ -89,11 +89,11 @@ func NewCmdCreate(f *cmdutils.Factory, runE func(opts *CreateOpts) error) *cobra Long: ``, Aliases: []string{"new"}, Example: heredoc.Doc(` - $ glab mr new - $ glab mr create -a username -t "fix annoying bug" - $ glab mr create -f --draft --label RFC - $ glab mr create --fill --yes --web - $ glab mr create --fill --fill-commit-body --yes + glab mr new + glab mr create -a username -t "fix annoying bug" + glab mr create -f --draft --label RFC + glab mr create --fill --yes --web + glab mr create --fill --fill-commit-body --yes `), Args: cobra.ExactArgs(0), PreRun: func(cmd *cobra.Command, args []string) { diff --git a/commands/mr/delete/mr_delete.go b/commands/mr/delete/mr_delete.go index 39c346e3..139b755a 100644 --- a/commands/mr/delete/mr_delete.go +++ b/commands/mr/delete/mr_delete.go @@ -18,11 +18,11 @@ func NewCmdDelete(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"del"}, Example: heredoc.Doc(` - $ glab mr delete 123 - $ glab mr delete 123 branch-name 789 # close multiple branches - $ glab mr delete 1,2,branch-related-to-mr-3,4,5 # close MRs !1,!2,!3,!4,!5 - $ glab mr del 123 - $ glab mr delete branch + glab mr delete 123 + glab mr delete 123 branch-name 789 # close multiple branches + glab mr delete 1,2,branch-related-to-mr-3,4,5 # close MRs !1,!2,!3,!4,!5 + glab mr del 123 + glab mr delete branch `), RunE: func(cmd *cobra.Command, args []string) error { c := f.IO.Color() diff --git a/commands/mr/diff/diff.go b/commands/mr/diff/diff.go index 8a967a23..6b4f6230 100644 --- a/commands/mr/diff/diff.go +++ b/commands/mr/diff/diff.go @@ -39,10 +39,10 @@ func NewCmdDiff(f *cmdutils.Factory, runF func(*DiffOptions) error) *cobra.Comma Use: "diff [ | ]", Short: "View changes in a merge request", Example: heredoc.Doc(` - $ glab mr diff 123 - $ glab mr diff branch - $ glab mr diff # get from current branch - $ glab mr diff 123 --color=never + glab mr diff 123 + glab mr diff branch + glab mr diff # get from current branch + glab mr diff 123 --color=never `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/for/mr_for.go b/commands/mr/for/mr_for.go index a611f0de..72699567 100644 --- a/commands/mr/for/mr_for.go +++ b/commands/mr/for/mr_for.go @@ -23,10 +23,10 @@ func NewCmdFor(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"new-for", "create-for", "for-issue"}, Example: heredoc.Doc(` - $ glab mr for 34 # Create mr for issue 34 - $ glab mr for 34 --wip # Create mr and mark as work in progress - $ glab mr new-for 34 - $ glab mr create-for 34 + glab mr for 34 # Create mr for issue 34 + glab mr for 34 --wip # Create mr and mark as work in progress + glab mr new-for 34 + glab mr create-for 34 `), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/issues/mr_issues.go b/commands/mr/issues/mr_issues.go index 87fd04ef..a0808575 100644 --- a/commands/mr/issues/mr_issues.go +++ b/commands/mr/issues/mr_issues.go @@ -22,9 +22,9 @@ func NewCmdIssues(f *cmdutils.Factory) *cobra.Command { Aliases: []string{"issue"}, Args: cobra.MaximumNArgs(1), Example: heredoc.Doc(` - $ glab mr issues 46 - $ glab mr issues branch - $ glab mr issues # use checked out branch + glab mr issues 46 + glab mr issues branch + glab mr issues # use checked out branch `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/mr/list/mr_list.go b/commands/mr/list/mr_list.go index 79162f04..63c0014c 100644 --- a/commands/mr/list/mr_list.go +++ b/commands/mr/list/mr_list.go @@ -63,16 +63,16 @@ func NewCmdList(f *cmdutils.Factory, runE func(opts *ListOptions) error) *cobra. Long: ``, Aliases: []string{"ls"}, Example: heredoc.Doc(` - $ glab mr list --all - $ glab mr ls -a - $ glab mr list --assignee=@me - $ glab mr list --reviewer=@me - $ glab mr list --source-branch=new-feature - $ glab mr list --target-branch=main - $ glab mr list --search "this adds feature X" - $ glab mr list --label needs-review - $ glab mr list --not-label waiting-maintainer-feedback,subsystem-x - $ glab mr list -M --per-page 10 + glab mr list --all + glab mr ls -a + glab mr list --assignee=@me + glab mr list --reviewer=@me + glab mr list --source-branch=new-feature + glab mr list --target-branch=main + glab mr list --search "this adds feature X" + glab mr list --label needs-review + glab mr list --not-label waiting-maintainer-feedback,subsystem-x + glab mr list -M --per-page 10 `), Args: cobra.ExactArgs(0), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/merge/mr_merge.go b/commands/mr/merge/mr_merge.go index f688af05..d77e768f 100644 --- a/commands/mr/merge/mr_merge.go +++ b/commands/mr/merge/mr_merge.go @@ -52,9 +52,9 @@ func NewCmdMerge(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"accept"}, Example: heredoc.Doc(` - $ glab mr merge 235 - $ glab mr accept 235 - $ glab mr merge # Finds open merge request from current branch + glab mr merge 235 + glab mr accept 235 + glab mr merge # Finds open merge request from current branch `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/mr.go b/commands/mr/mr.go index 51bf2115..2b1925d6 100644 --- a/commands/mr/mr.go +++ b/commands/mr/mr.go @@ -33,9 +33,9 @@ func NewCmdMR(f *cmdutils.Factory) *cobra.Command { Short: `Create, view and manage merge requests`, Long: ``, Example: heredoc.Doc(` - $ glab mr create --fill --label bugfix - $ glab mr merge 123 - $ glab mr note -m "needs to do X before it can be merged" branch-foo + glab mr create --fill --label bugfix + glab mr merge 123 + glab mr note -m "needs to do X before it can be merged" branch-foo `), Annotations: map[string]string{ "help:arguments": heredoc.Doc(` diff --git a/commands/mr/rebase/mr_rebase.go b/commands/mr/rebase/mr_rebase.go index 816c6820..2414c499 100644 --- a/commands/mr/rebase/mr_rebase.go +++ b/commands/mr/rebase/mr_rebase.go @@ -12,11 +12,12 @@ func NewCmdRebase(f *cmdutils.Factory) *cobra.Command { var mrRebaseCmd = &cobra.Command{ Use: "rebase [ | ] [flags]", Short: `Automatically rebase the source_branch of the merge request against its target_branch.`, - Long: `If you don’t have permissions to push to the merge request’s source branch - you’ll get a 403 Forbidden response.`, + Long: heredoc.Doc(`If you don't have permissions to push to the merge request's source branch - you'll get a 403 Forbidden response. + `), Example: heredoc.Doc(` - $ glab mr rebase 123 - $ glab mr rebase # get from current branch - $ glab mr rebase branch + glab mr rebase 123 + glab mr rebase # get from current branch + glab mr rebase branch `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/reopen/mr_reopen.go b/commands/mr/reopen/mr_reopen.go index 12b0b78b..5e610dc8 100644 --- a/commands/mr/reopen/mr_reopen.go +++ b/commands/mr/reopen/mr_reopen.go @@ -17,10 +17,10 @@ func NewCmdReopen(f *cmdutils.Factory) *cobra.Command { Use: "reopen [... | ...]", Short: `Reopen merge requests`, Example: heredoc.Doc(` - $ glab mr reopen 123 - $ glab mr reopen 123 456 789 - $ glab mr reopen branch-1 branch-2 - $ glab mr reopen # use checked out branch + glab mr reopen 123 + glab mr reopen 123 456 789 + glab mr reopen branch-1 branch-2 + glab mr reopen # use checked out branch `), Aliases: []string{"open"}, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/mr/revoke/mr_revoke.go b/commands/mr/revoke/mr_revoke.go index 425efee0..519af2be 100644 --- a/commands/mr/revoke/mr_revoke.go +++ b/commands/mr/revoke/mr_revoke.go @@ -14,15 +14,15 @@ import ( func NewCmdRevoke(f *cmdutils.Factory) *cobra.Command { var mrRevokeCmd = &cobra.Command{ Use: "revoke [ | ]", - Short: `Revoke approval on a merge request `, + Short: `Revoke approval on a merge request`, Long: ``, Aliases: []string{"unapprove"}, Example: heredoc.Doc(` - $ glab mr revoke 123 - $ glab mr unapprove 123 - $ glab mr revoke branch - $ glab mr revoke # use checked out branch - $ glab mr revoke 123 branch 456 + glab mr revoke 123 + glab mr unapprove 123 + glab mr revoke branch + glab mr revoke # use checked out branch + glab mr revoke 123 branch 456 `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/mr/subscribe/mr_subscribe.go b/commands/mr/subscribe/mr_subscribe.go index 62d79cf8..f6e4837b 100644 --- a/commands/mr/subscribe/mr_subscribe.go +++ b/commands/mr/subscribe/mr_subscribe.go @@ -18,10 +18,10 @@ func NewCmdSubscribe(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"sub"}, Example: heredoc.Doc(` - $ glab mr subscribe 123 - $ glab mr sub 123 - $ glab mr subscribe branch - $ glab mr subscribe 123 branch # subscribe to multiple MRs + glab mr subscribe 123 + glab mr sub 123 + glab mr subscribe branch + glab mr subscribe 123 branch # subscribe to multiple MRs `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/mr/unsubscribe/mr_unsubscribe.go b/commands/mr/unsubscribe/mr_unsubscribe.go index 32cbe418..3330f9ec 100644 --- a/commands/mr/unsubscribe/mr_unsubscribe.go +++ b/commands/mr/unsubscribe/mr_unsubscribe.go @@ -18,10 +18,10 @@ func NewCmdUnsubscribe(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"unsub"}, Example: heredoc.Doc(` - $ glab mr unsubscribe 123 - $ glab mr unsub 123 - $ glab mr unsubscribe branch - $ glab mr unsubscribe 123 branch # unsubscribe from multiple MRs + glab mr unsubscribe 123 + glab mr unsub 123 + glab mr unsubscribe branch + glab mr unsubscribe 123 branch # unsubscribe from multiple MRs `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/mr/update/mr_update.go b/commands/mr/update/mr_update.go index dde56a38..ee91fa8c 100644 --- a/commands/mr/update/mr_update.go +++ b/commands/mr/update/mr_update.go @@ -20,9 +20,9 @@ func NewCmdUpdate(f *cmdutils.Factory) *cobra.Command { Short: `Update merge requests`, Long: ``, Example: heredoc.Doc(` - $ glab mr update 23 --ready - $ glab mr update 23 --draft - $ glab mr update --draft # Updates MR related to current branch + glab mr update 23 --ready + glab mr update 23 --draft + glab mr update --draft # Updates MR related to current branch `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/project/archive/repo_archive.go b/commands/project/archive/repo_archive.go index 661abc0e..7d665d8d 100644 --- a/commands/project/archive/repo_archive.go +++ b/commands/project/archive/repo_archive.go @@ -20,13 +20,14 @@ func NewCmdArchive(f *cmdutils.Factory) *cobra.Command { Use: "archive [flags]", Short: `Get an archive of the repository.`, Example: heredoc.Doc(` - $ glab repo archive profclems/glab - $ glab repo archive # Downloads zip file of current repository - $ glab repo archive profclems/glab mydirectory # Downloads repo zip file into mydirectory - $ glab repo archive profclems/glab --format=zip # Finds repo for current user and download in zip format + glab repo archive profclems/glab + glab repo archive # Downloads zip file of current repository + glab repo archive profclems/glab mydirectory # Downloads repo zip file into mydirectory + glab repo archive profclems/glab --format=zip # Finds repo for current user and download in zip format `), Long: heredoc.Doc(` Clone supports these shorthands + - repo - namespace/repo - namespace/group/repo diff --git a/commands/project/clone/repo_clone.go b/commands/project/clone/repo_clone.go index 113c4489..21fa0f16 100644 --- a/commands/project/clone/repo_clone.go +++ b/commands/project/clone/repo_clone.go @@ -62,7 +62,7 @@ func NewCmdClone(f *cmdutils.Factory, runE func(*CloneOptions, *ContextOpts) err var repoCloneCmd = &cobra.Command{ Use: "clone [] [-- [...]]", - Short: `Clone a Gitlab repository/project`, + Short: `Clone a GitLab repository/project`, Example: heredoc.Doc(` $ glab repo clone profclems/glab @@ -81,13 +81,12 @@ func NewCmdClone(f *cmdutils.Factory, runE func(*CloneOptions, *ContextOpts) err $ GITLAB_HOST=salsa.debian.org glab repo clone myrepo `), Long: heredoc.Doc(` -Clone a GitLab repository/project - - Clone supports these shorthands - - repo - - namespace/repo - - org/group/repo - - project ID + Clone supports these shorthands + + - repo + - namespace/repo + - org/group/repo + - project ID `), RunE: func(cmd *cobra.Command, args []string) error { if nArgs := len(args); nArgs > 0 { diff --git a/commands/project/create/project_create.go b/commands/project/create/project_create.go index 2f0a890a..3bbafd2f 100644 --- a/commands/project/create/project_create.go +++ b/commands/project/create/project_create.go @@ -23,8 +23,8 @@ import ( func NewCmdCreate(f *cmdutils.Factory) *cobra.Command { var projectCreateCmd = &cobra.Command{ Use: "create [path] [flags]", - Short: `Create a new GitLab project/repository`, - Long: `Create a new GitLab repository.`, + Short: `Create a new GitLab project/repository.`, + Long: ``, Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { return runCreateProject(cmd, args, f) diff --git a/commands/project/delete/delete.go b/commands/project/delete/delete.go index ad986829..afdf54ad 100644 --- a/commands/project/delete/delete.go +++ b/commands/project/delete/delete.go @@ -34,8 +34,8 @@ func NewCmdDelete(f *cmdutils.Factory) *cobra.Command { var projectCreateCmd = &cobra.Command{ Use: "delete [/]", - Short: `Delete an existing repository on GitLab`, - Long: `Delete an existing repository on GitLab`, + Short: `Delete an existing repository on GitLab.`, + Long: ``, Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Args = args diff --git a/commands/project/fork/fork.go b/commands/project/fork/fork.go index badac762..a156995c 100644 --- a/commands/project/fork/fork.go +++ b/commands/project/fork/fork.go @@ -55,9 +55,9 @@ func NewCmdFork(f *cmdutils.Factory, runE func(*cmdutils.Factory) error) *cobra. Use: "fork ", Short: "Create a fork of a GitLab repository", Example: heredoc.Doc(` - $ glab repo fork - $ glab repo fork namespace/repo - $ glab repo fork namespace/repo --clone + glab repo fork + glab repo fork namespace/repo + glab repo fork namespace/repo --clone `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) (err error) { diff --git a/commands/project/list/list.go b/commands/project/list/list.go index 50fc9f01..c10528fc 100644 --- a/commands/project/list/list.go +++ b/commands/project/list/list.go @@ -36,7 +36,7 @@ func NewCmdList(f *cmdutils.Factory) *cobra.Command { Use: "list", Short: `Get list of repositories.`, Example: heredoc.Doc(` - $ glab repo list + glab repo list `), Args: cobra.ExactArgs(0), Aliases: []string{"users"}, diff --git a/commands/project/mirror/project_mirror.go b/commands/project/mirror/project_mirror.go index 10ee5501..9759cd70 100644 --- a/commands/project/mirror/project_mirror.go +++ b/commands/project/mirror/project_mirror.go @@ -34,8 +34,8 @@ func NewCmdMirror(f *cmdutils.Factory) *cobra.Command { var projectMirrorCmd = &cobra.Command{ Use: "mirror [ID | URL | PATH] [flags]", - Short: "Mirror a project/repository", - Long: `Mirrors a project/repository to the specified location using pull or push method.`, + Short: "Mirror a project/repository to the specified location using pull or push method.", + Long: ``, Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/project/search/project_search.go b/commands/project/search/project_search.go index 0cadec8b..a3d14ab4 100644 --- a/commands/project/search/project_search.go +++ b/commands/project/search/project_search.go @@ -21,10 +21,10 @@ func NewCmdSearch(f *cmdutils.Factory) *cobra.Command { Args: cobra.ExactArgs(0), Aliases: []string{"find", "lookup"}, Example: heredoc.Doc(` - $ glab project search title - $ glab repo search title - $ glab project find title - $ glab project lookup title + glab project search title + glab repo search title + glab project find title + glab project lookup title `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/project/transfer/project_transfer.go b/commands/project/transfer/project_transfer.go index c73982b1..b0a776b8 100644 --- a/commands/project/transfer/project_transfer.go +++ b/commands/project/transfer/project_transfer.go @@ -14,7 +14,7 @@ func NewCmdTransfer(f *cmdutils.Factory) *cobra.Command { Use: "transfer [repo] [flags]", Short: `Transfer a repository to a new namespace.`, Example: heredoc.Doc(` - $ glab repo transfer profclems/glab --target-namespace notprofclems + glab repo transfer profclems/glab --target-namespace notprofclems `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/project/view/project_view.go b/commands/project/view/project_view.go index a3b1705c..016c512c 100644 --- a/commands/project/view/project_view.go +++ b/commands/project/view/project_view.go @@ -35,7 +35,8 @@ func NewCmdView(f *cmdutils.Factory) *cobra.Command { var projectViewCmd = &cobra.Command{ Use: "view [repository] [flags]", Short: "View a project/repository", - Long: `Display the description and README of a project or open it in the browser.`, + Long: heredoc.Doc(`Display the description and README of a project or open it in the browser. + `), Args: cobra.MaximumNArgs(1), Example: heredoc.Doc(` # view project information for the current directory diff --git a/commands/release/create/create.go b/commands/release/create/create.go index e3572861..d6c6ac92 100644 --- a/commands/release/create/create.go +++ b/commands/release/create/create.go @@ -65,16 +65,16 @@ func NewCmdCreate(f *cmdutils.Factory, runE func(opts *CreateOpts) error) *cobra If the release already exists, glab updates the release with the new info provided. - If a git tag specified does not yet exist, the release will automatically get created + If a Git tag specified does not yet exist, the release will automatically get created from the latest state of the default branch and tagged with the specified tag name. Use %[1]s--ref%[1]s to override this. The %[1]sref%[1]s can be a commit SHA, another tag name, or a branch name. To fetch the new tag locally after the release, do %[1]sgit fetch --tags origin%[1]s. - To create a release from an annotated git tag, first create one locally with - git, push the tag to GitLab, then run this command. + To create a release from an annotated Git tag, first create one locally with + Git, push the tag to GitLab, then run this command. - NB: Developer level access to the project is required to create a release. + Developer level access to the project is required to create a release. `, "`"), Args: cmdutils.MinimumArgs(1, "no tag name provided"), Example: heredoc.Doc(` @@ -101,14 +101,14 @@ func NewCmdCreate(f *cmdutils.Factory, runE func(opts *CreateOpts) error) *cobra Create a release with assets specified as JSON object $ glab release create v1.0.1 --assets-links=' - [ - { - "name": "Asset1", - "url":"https:///some/location/1", - "link_type": "other", - "filepath": "path/to/file" - } - ]' + [ + { + "name": "Asset1", + "url":"https:///some/location/1", + "link_type": "other", + "filepath": "path/to/file" + } + ]' `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/release/delete/delete.go b/commands/release/delete/delete.go index 560ff8bb..692fb23f 100644 --- a/commands/release/delete/delete.go +++ b/commands/release/delete/delete.go @@ -36,7 +36,7 @@ func NewCmdDelete(f *cmdutils.Factory, runE func(opts *DeleteOpts) error) *cobra cmd := &cobra.Command{ Use: "delete ", - Short: "Delete a GitLab Release", + Short: "Delete a GitLab Release", Long: heredoc.Docf(`Delete release assets to GitLab Release Deleting a release does not delete the associated tag unless %[1]s--with-tag%[1]s is specified. diff --git a/commands/release/upload/upload.go b/commands/release/upload/upload.go index e898cc95..0af663d4 100644 --- a/commands/release/upload/upload.go +++ b/commands/release/upload/upload.go @@ -70,14 +70,14 @@ func NewCmdUpload(f *cmdutils.Factory, runE func(opts *UploadOpts) error) *cobra Upload release assets links specified as JSON string $ glab release upload v1.0.1 --assets-links=' - [ - { - "name": "Asset1", - "url":"https:///some/location/1", - "link_type": "other", - "filepath": "path/to/file" - } - ]' + [ + { + "name": "Asset1", + "url":"https:///some/location/1", + "link_type": "other", + "filepath": "path/to/file" + } + ]' `), RunE: func(cmd *cobra.Command, args []string) error { var err error diff --git a/commands/release/view/view.go b/commands/release/view/view.go index 15d168d3..9179a058 100644 --- a/commands/release/view/view.go +++ b/commands/release/view/view.go @@ -35,10 +35,10 @@ func NewCmdView(f *cmdutils.Factory, runE func(opts *ViewOpts) error) *cobra.Com cmd := &cobra.Command{ Use: "view ", Short: "View information about a GitLab Release", - Long: heredoc.Docf(`View information about a GitLab Release. + Long: heredoc.Doc(`View information about a GitLab Release. Without an explicit tag name argument, the latest release in the project is shown. - `, "`"), + `,), Example: heredoc.Doc(` View the latest release of a GitLab repository $ glab release view diff --git a/commands/snippet/create/create.go b/commands/snippet/create/create.go index e6b3f435..69ac995f 100644 --- a/commands/snippet/create/create.go +++ b/commands/snippet/create/create.go @@ -41,9 +41,9 @@ func NewCmdCreate(f *cmdutils.Factory) *cobra.Command { Long: ``, Aliases: []string{"new"}, Example: heredoc.Doc(` - $ glab snippet create script.py --title "Title of the snippet" - $ echo "package main" | glab snippet new --title "Title of the snippet" --filename "main.go" - $ glab snippet create main.go -t Title -f "different.go" -d Description + glab snippet create script.py --title "Title of the snippet" + echo "package main" | glab snippet new --title "Title of the snippet" --filename "main.go" + glab snippet create main.go -t Title -f "different.go" -d Description `), PreRunE: func(cmd *cobra.Command, args []string) error { opts.IO = f.IO diff --git a/commands/snippet/snippet.go b/commands/snippet/snippet.go index 4bf7a57f..9b7ad8e9 100644 --- a/commands/snippet/snippet.go +++ b/commands/snippet/snippet.go @@ -13,7 +13,7 @@ func NewCmdSnippet(f *cmdutils.Factory) *cobra.Command { Short: `Create, view and manage snippets`, Long: ``, Example: heredoc.Doc(` - $ glab snippet create --title "Title of the snippet" --filename "main.go" + glab snippet create --title "Title of the snippet" --filename "main.go" `), Annotations: map[string]string{ "help:arguments": heredoc.Doc(` diff --git a/commands/ssh-key/get/get.go b/commands/ssh-key/get/get.go index 5b44b4e5..aa60cff1 100644 --- a/commands/ssh-key/get/get.go +++ b/commands/ssh-key/get/get.go @@ -28,8 +28,8 @@ func NewCmdGet(f *cmdutils.Factory, runE func(*GetOpts) error) *cobra.Command { } cmd := &cobra.Command{ Use: "get ", - Short: "Gets a single key", - Long: "Returns a single SSH key specified by the ID", + Short: "Returns a single SSH key specified by the ID.", + Long: ``, Example: heredoc.Doc(` # Get ssh key with ID as argument $ glab ssh-key get 7750633 diff --git a/commands/ssh-key/list/list.go b/commands/ssh-key/list/list.go index 110f79f1..b8ed37d3 100644 --- a/commands/ssh-key/list/list.go +++ b/commands/ssh-key/list/list.go @@ -25,10 +25,10 @@ func NewCmdList(f *cmdutils.Factory, runE func(*ListOpts) error) *cobra.Command } cmd := &cobra.Command{ Use: "list", - Short: "Lists currently authenticated user’s SSH keys", - Long: "Get a list of currently authenticated user’s SSH keys", + Short: "Get a list of currently authenticated user's SSH keys.", + Long: "", Example: heredoc.Doc(` - $ glab ssh-key list + glab ssh-key list `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/commands/ssh-key/ssh-key.go b/commands/ssh-key/ssh-key.go index 507ddf09..6a279af3 100644 --- a/commands/ssh-key/ssh-key.go +++ b/commands/ssh-key/ssh-key.go @@ -11,8 +11,8 @@ import ( func NewCmdSSHKey(f *cmdutils.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "ssh-key ", - Short: "Manage SSH keys", - Long: "Manage SSH keys registered with your GitLab account", + Short: "Manage SSH keys registered with your GitLab account.", + Long: "", } cmdutils.EnableRepoOverride(cmd, f) diff --git a/commands/variable/delete/delete.go b/commands/variable/delete/delete.go index b68ecb7a..1d6bb35c 100644 --- a/commands/variable/delete/delete.go +++ b/commands/variable/delete/delete.go @@ -37,9 +37,9 @@ func NewCmdSet(f *cmdutils.Factory, runE func(opts *DeleteOpts) error) *cobra.Co Aliases: []string{"remove"}, Args: cobra.ExactArgs(1), Example: heredoc.Doc(` - $ glab variable delete VAR_NAME - $ glab variable delete VAR_NAME --scope=prod - $ glab variable delete VARNAME -g mygroup + glab variable delete VAR_NAME + glab variable delete VAR_NAME --scope=prod + glab variable delete VARNAME -g mygroup `), RunE: func(cmd *cobra.Command, args []string) (err error) { opts.HTTPClient = f.HttpClient diff --git a/commands/variable/get/get.go b/commands/variable/get/get.go index 58b32ad3..2a88680b 100644 --- a/commands/variable/get/get.go +++ b/commands/variable/get/get.go @@ -32,8 +32,8 @@ func NewCmdSet(f *cmdutils.Factory, runE func(opts *GetOps) error) *cobra.Comman Short: "get a project or group variable", Args: cobra.RangeArgs(1, 1), Example: heredoc.Doc(` - $ glab variable get VAR_KEY - $ glab variable get -g GROUP VAR_KEY + glab variable get VAR_KEY + glab variable get -g GROUP VAR_KEY `), RunE: func(cmd *cobra.Command, args []string) (err error) { diff --git a/commands/variable/list/list.go b/commands/variable/list/list.go index 511757af..11621e31 100644 --- a/commands/variable/list/list.go +++ b/commands/variable/list/list.go @@ -31,7 +31,7 @@ func NewCmdSet(f *cmdutils.Factory, runE func(opts *ListOpts) error) *cobra.Comm Aliases: []string{"new", "create"}, Args: cobra.ExactArgs(0), Example: heredoc.Doc(` - $ glab variable list + glab variable list `), RunE: func(cmd *cobra.Command, args []string) (err error) { // Supports repo override diff --git a/commands/variable/set/set.go b/commands/variable/set/set.go index dea54156..05b21863 100644 --- a/commands/variable/set/set.go +++ b/commands/variable/set/set.go @@ -40,13 +40,13 @@ func NewCmdSet(f *cmdutils.Factory, runE func(opts *SetOpts) error) *cobra.Comma Aliases: []string{"new", "create"}, Args: cobra.RangeArgs(1, 2), Example: heredoc.Doc(` - $ glab variable set WITH_ARG "some value" - $ glab variable set FROM_FLAG -v "some value" - $ glab variable set FROM_ENV_WITH_ARG "${ENV_VAR}" - $ glab variable set FROM_ENV_WITH_FLAG -v"${ENV_VAR}" - $ glab variable set FROM_FILE < secret.txt - $ cat file.txt | glab variable set SERVER_TOKEN - $ cat token.txt | glab variable set GROUP_TOKEN -g mygroup --scope=prod + glab variable set WITH_ARG "some value" + glab variable set FROM_FLAG -v "some value" + glab variable set FROM_ENV_WITH_ARG "${ENV_VAR}" + glab variable set FROM_ENV_WITH_FLAG -v"${ENV_VAR}" + glab variable set FROM_FILE < secret.txt + cat file.txt | glab variable set SERVER_TOKEN + cat token.txt | glab variable set GROUP_TOKEN -g mygroup --scope=prod `), RunE: func(cmd *cobra.Command, args []string) (err error) { // Supports repo override diff --git a/commands/variable/update/update.go b/commands/variable/update/update.go index 415d5331..9e567aa4 100644 --- a/commands/variable/update/update.go +++ b/commands/variable/update/update.go @@ -39,13 +39,13 @@ func NewCmdSet(f *cmdutils.Factory, runE func(opts *UpdateOpts) error) *cobra.Co Short: "Update an existing project or group variable", Args: cobra.RangeArgs(1, 2), Example: heredoc.Doc(` - $ 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 + 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 `), RunE: func(cmd *cobra.Command, args []string) (err error) { // Supports repo override diff --git a/docs/.vale/gitlab/Admin.yml b/docs/.vale/gitlab/Admin.yml new file mode 100644 index 00000000..78a86e27 --- /dev/null +++ b/docs/.vale/gitlab/Admin.yml @@ -0,0 +1,13 @@ +--- +# Suggestion: gitlab.Admin +# +# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: 'Verify this use of the word "admin". Can it be updated to "administration", "administrator", "administer", or "Admin Area"?' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +level: suggestion +ignorecase: false +swap: + '[Aa]dmin ?\w*': '(?:Admin( Area| Mode)?|[Aa]dminist(ration|rator|rators|er|rative|ering|ered))' diff --git a/docs/.vale/gitlab/AlertBoxStyle.yml b/docs/.vale/gitlab/AlertBoxStyle.yml new file mode 100644 index 00000000..5912c470 --- /dev/null +++ b/docs/.vale/gitlab/AlertBoxStyle.yml @@ -0,0 +1,20 @@ +--- +# Error: gitlab.AlertBoxStyle +# +# Makes sure alert boxes are used with block quotes. Checks for 3 formatting issues: +# +# - Alert boxes inside a block quote (">") +# - Alert boxes with the note text on the same line +# - Alert boxes using words other than "NOTE" or "WARNING" +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Alert box "%s" must use the formatting in the style guide.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes +level: error +nonword: true +scope: raw +raw: + - '(\n *\> *(?:NOTE|WARNING)|' + - '\n\n(NOTE|WARNING):[^\n]|' + - '\n\n *(?:> )?\**(Note|note|TIP|Tip|tip|CAUTION|Caution|caution|DANGER|Danger|danger|Warning|warning):.*)' diff --git a/docs/.vale/gitlab/BadPlurals.yml b/docs/.vale/gitlab/BadPlurals.yml new file mode 100644 index 00000000..533805c6 --- /dev/null +++ b/docs/.vale/gitlab/BadPlurals.yml @@ -0,0 +1,13 @@ +--- +# Warning: gitlab.BadPlurals +# +# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable. +# +# For a list of all options, see https://docs.errata.ai/vale/styles +extends: existence +message: 'Rewrite "%s" to be plural, without parentheses.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#s +level: warning +ignorecase: true +raw: + - '\b\w+\(s\)(?>>>>>> .+\n' diff --git a/docs/.vale/gitlab/MultiLineLinks.yml b/docs/.vale/gitlab/MultiLineLinks.yml new file mode 100644 index 00000000..64ad017f --- /dev/null +++ b/docs/.vale/gitlab/MultiLineLinks.yml @@ -0,0 +1,14 @@ +--- +# Error: gitlab.MultiLineLinks +# +# Checks that links are all on a single line. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Link "%s" must be on a single line, even if very long.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +level: error +scope: raw +raw: + - '\[[^\[\]]*?\n[^\[\]]*?\]\([^\)]*?\)|' + - '\[[^\[\]]*?\]\([^\)]*?\n[^\)]*\)' diff --git a/docs/.vale/gitlab/NonStandardQuotes.yml b/docs/.vale/gitlab/NonStandardQuotes.yml new file mode 100644 index 00000000..f31d615e --- /dev/null +++ b/docs/.vale/gitlab/NonStandardQuotes.yml @@ -0,0 +1,14 @@ +--- +# Warning: gitlab.NonStandardQuotes +# +# Use only standard single and double quotes, not left or right quotes. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Use standard single quotes or double quotes only. Do not use left or right quotes.' +level: warning +ignorecase: true +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +scope: raw +raw: + - '[‘’“”]' diff --git a/docs/.vale/gitlab/OutdatedVersions.yml b/docs/.vale/gitlab/OutdatedVersions.yml new file mode 100644 index 00000000..f25de44a --- /dev/null +++ b/docs/.vale/gitlab/OutdatedVersions.yml @@ -0,0 +1,24 @@ +--- +# Suggestion: gitlab.OutdatedVersions +# +# Checks for references to versions of GitLab that are no longer supported. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Can this reference to "%s" be refactored?' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#gitlab-versions +level: suggestion +nonword: true +ignorecase: true +tokens: + - "GitLab (v)?2." + - "GitLab (v)?3." + - "GitLab (v)?4." + - "GitLab (v)?5." + - "GitLab (v)?6." + - "GitLab (v)?7." + - "GitLab (v)?8." + - "GitLab (v)?9." + - "GitLab (v)?10." + - "GitLab (v)?11." + - "GitLab (v)?12." diff --git a/docs/.vale/gitlab/OxfordComma.yml b/docs/.vale/gitlab/OxfordComma.yml new file mode 100644 index 00000000..1716145b --- /dev/null +++ b/docs/.vale/gitlab/OxfordComma.yml @@ -0,0 +1,12 @@ +--- +# Warning: gitlab.OxfordComma +# +# Checks for the lack of an Oxford comma. In some cases, will catch overly complex sentence structures with lots of commas. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Use a comma before the last "and" or "or" in a list of four or more items.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation +level: warning +raw: + - '(?:[\w-_` ]+,){2,}(?:[\w-_` ]+) (and |or )' diff --git a/docs/.vale/gitlab/Possessive.yml b/docs/.vale/gitlab/Possessive.yml new file mode 100644 index 00000000..92ae6654 --- /dev/null +++ b/docs/.vale/gitlab/Possessive.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.Possessive +# +# The word GitLab should not be used in the possessive form. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: "Rewrite '%s' to not use 's." +level: error +ignorecase: true +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#trademark +tokens: + - GitLab's diff --git a/docs/.vale/gitlab/ReadingLevel.yml b/docs/.vale/gitlab/ReadingLevel.yml new file mode 100644 index 00000000..cd7597ee --- /dev/null +++ b/docs/.vale/gitlab/ReadingLevel.yml @@ -0,0 +1,13 @@ +--- +# Suggestion: gitlab.ReadingLevel +# +# Checks the Flesch-Kincaid reading level. +# +# https://docs.errata.ai/vale/styles#metric +extends: metric +message: "The grade level - %s - refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words." +link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score +level: suggestion +formula: | + (0.39 * (words / sentences)) + (11.8 * (syllables / words)) - 15.59 +condition: "> 1" diff --git a/docs/.vale/gitlab/ReferenceLinks.yml b/docs/.vale/gitlab/ReferenceLinks.yml new file mode 100644 index 00000000..ca994884 --- /dev/null +++ b/docs/.vale/gitlab/ReferenceLinks.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.ReferenceLinks +# +# Checks for reference-style links that should be converted to inline links. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Link "%s" must be inline.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +level: error +scope: raw +raw: + - '\n\[[^\]]*\]: .*' diff --git a/docs/.vale/gitlab/RelativeLinks.yml b/docs/.vale/gitlab/RelativeLinks.yml new file mode 100644 index 00000000..01e30f60 --- /dev/null +++ b/docs/.vale/gitlab/RelativeLinks.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.RelativeLinks +# +# Checks for the presence of absolute hyperlinks that should be relative. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Link "%s" must be a relative link with a .md extension.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +level: warning +scope: raw +raw: + - '\[.+\]\(https?:\/\/docs\.gitlab\.com\/[ce]e.*\)' diff --git a/docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml b/docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml new file mode 100644 index 00000000..ce6ce8b5 --- /dev/null +++ b/docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.RelativeLinksDoubleSlashes +# +# Checks for the presence of double slashes in relative URLs. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Relative links must not include a double slash.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +level: error +scope: raw +raw: + - '\.//' diff --git a/docs/.vale/gitlab/Repetition.yml b/docs/.vale/gitlab/Repetition.yml new file mode 100644 index 00000000..c4b0cc14 --- /dev/null +++ b/docs/.vale/gitlab/Repetition.yml @@ -0,0 +1,12 @@ +--- +# Error: gitlab.Repetition +# +# Checks for duplicate words, like `the the` or `and and`. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: repetition +message: '"%s" is repeated.' +level: error +alpha: true +tokens: + - '[^\s]+' diff --git a/docs/.vale/gitlab/SentenceLength.yml b/docs/.vale/gitlab/SentenceLength.yml new file mode 100644 index 00000000..c60df180 --- /dev/null +++ b/docs/.vale/gitlab/SentenceLength.yml @@ -0,0 +1,13 @@ +--- +# Warning: gitlab.SentenceLength +# +# Counts words in a sentence and alerts if a sentence exceeds 25 words. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: occurrence +message: 'Shorter sentences improve readability (max 25 words).' +scope: sentence +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language +level: warning +max: 25 +token: \b(\w+)\b diff --git a/docs/.vale/gitlab/SentenceSpacing.yml b/docs/.vale/gitlab/SentenceSpacing.yml new file mode 100644 index 00000000..0288abe8 --- /dev/null +++ b/docs/.vale/gitlab/SentenceSpacing.yml @@ -0,0 +1,14 @@ +--- +# Error: gitlab.SentenceSpacing +# +# Checks for incorrect spacing (no spaces, or more than one space) around punctuation. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: '"%s" must contain one and only one space.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation +level: error +nonword: true +tokens: + - '[a-z][.?!,][A-Z]' + - '[\w.?!,\(\)\-":] {2,}[\w.?!,\(\)\-":]' diff --git a/docs/.vale/gitlab/Simplicity.yml b/docs/.vale/gitlab/Simplicity.yml new file mode 100644 index 00000000..44e78f89 --- /dev/null +++ b/docs/.vale/gitlab/Simplicity.yml @@ -0,0 +1,18 @@ +--- +# Suggestion: gitlab.Simplicity +# +# Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Avoid words like "%s" that imply ease of use, because the user may find this action hard.' +level: suggestion +ignorecase: true +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +tokens: + - easy + - easily + - handy + - simple + - simply + - useful diff --git a/docs/.vale/gitlab/Spelling.yml b/docs/.vale/gitlab/Spelling.yml new file mode 100644 index 00000000..4ebaf7bf --- /dev/null +++ b/docs/.vale/gitlab/Spelling.yml @@ -0,0 +1,16 @@ +--- +# Warning: gitlab.Spelling +# +# Checks for possible spelling mistakes in content, not code. Results from links using angle brackets () should be corrected. +# +# If a word is flagged as a spelling mistake incorrectly, such as a product name, +# you can submit an MR to update `spelling-exceptions.txt` with the missing word. +# Commands, like `git clone` must use backticks, and must not be added to the +# exceptions. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: spelling +message: 'Spelling check: "%s"?' +level: warning +ignore: + - gitlab/spelling-exceptions.txt diff --git a/docs/.vale/gitlab/SubstitutionSuggestions.yml b/docs/.vale/gitlab/SubstitutionSuggestions.yml new file mode 100644 index 00000000..4b77def0 --- /dev/null +++ b/docs/.vale/gitlab/SubstitutionSuggestions.yml @@ -0,0 +1,28 @@ +--- +# Suggestion: gitlab.SubstitutionSuggestions +# +# Suggests better options for frequently misused terms that are often - but not always - incorrect. +# SubstitutionWarning.yml and Substitutions.yml also exist. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: substitution +message: 'Consider %s instead of "%s".' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: suggestion +ignorecase: true +swap: + active user: '"billable user"' + active users: '"billable users"' + docs: '"documentation"' + e-mail: '"email"' + GLFM: '"GitLab Flavored Markdown"' + it is recommended: '"we recommend"' + navigate: go + OAuth2: '"OAuth 2.0"' + once that: '"after that"' + once the: '"after the"' + once you: '"after you"' + since: '"because" or "after"' + sub-group: '"subgroup"' + sub-groups: '"subgroups"' + within: '"in"' diff --git a/docs/.vale/gitlab/SubstitutionWarning.yml b/docs/.vale/gitlab/SubstitutionWarning.yml new file mode 100644 index 00000000..d17015b9 --- /dev/null +++ b/docs/.vale/gitlab/SubstitutionWarning.yml @@ -0,0 +1,29 @@ +--- +# Warning: gitlab.SubstitutionWarning +# +# Checks for misused terms or common shorthand that should never be used at GitLab, but can't be flagged as errors. +# Substitutions.yml and SubstitionSuggestions.yml also exist. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: 'If possible, use "%s" instead of "%s".' +link: https://about.gitlab.com/handbook/communication/#top-misused-terms +level: warning +ignorecase: true +swap: + air(?:-| )?gapped: offline environment + bullet: list item + click: select + code base: codebase + config: configuration + deselect: clear + deselected: cleared + distro: distribution + file name: filename + filesystem: file system + GFM: GLFM + info: information + n/a: not applicable + repo: repository + timezone: time zone + utilize: use diff --git a/docs/.vale/gitlab/Substitutions.yml b/docs/.vale/gitlab/Substitutions.yml new file mode 100644 index 00000000..af426fa7 --- /dev/null +++ b/docs/.vale/gitlab/Substitutions.yml @@ -0,0 +1,62 @@ +--- +# Error: gitlab.Substitutions +# +# Checks for misused terms that should never be used at GitLab. +# SubstitutionWarning.yml and SubstitionSuggestions.yml also exist. +# +# For a list of all options, see https://docs.errata.ai/vale/styles +extends: substitution +message: 'Use "%s" instead of "%s".' +link: https://about.gitlab.com/handbook/communication/#top-misused-terms +level: error +ignorecase: true +swap: + codequality: code quality + Customer [Pp]ortal: Customers Portal + disallow: prevent + frontmatter: front matter + GitLabber: GitLab team member + GitLabbers: GitLab team members + GitLab-shell: GitLab Shell + gitlab omnibus: Omnibus GitLab + param: parameter + params: parameters + pg: PostgreSQL + 'postgres$': PostgreSQL + raketask: Rake task + raketasks: Rake tasks + rspec: RSpec + self hosted: self-managed + self-hosted: self-managed + styleguide: style guide + to login: to log in + can login: can log in + to log-in: to log in + can log-in: can log in + to signin: to sign in + can signin: can sign in + to sign-in: to sign in + can sign-in: can sign in + x509: X.509 + yml: YAML + admin user: administrator + admin users: administrators + administrator permission: administrator access + administrator permissions: administrator access + administrator role: administrator access + the administrator access level: administrator access + developer access: the Developer role + developer permission: the Developer role + developer permissions: the Developer role + guest access: the Guest role + guest permission: the Guest role + guest permissions: the Guest role + maintainer access: the Maintainer role + maintainer permission: the Maintainer role + maintainer permissions: the Maintainer role + owner access: the Owner role + owner permission: the Owner role + owner permissions: the Owner role + reporter access: the Reporter role + reporter permission: the Reporter role + reporter permissions: the Reporter role diff --git a/docs/.vale/gitlab/ToDo.yml b/docs/.vale/gitlab/ToDo.yml new file mode 100644 index 00000000..a3725cb7 --- /dev/null +++ b/docs/.vale/gitlab/ToDo.yml @@ -0,0 +1,14 @@ +--- +# Warning: gitlab.ToDo +# +# You should not use "To Do", unless it refers to the UI element. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: substitution +message: 'Use "to-do item" in most cases, or "Add a to do" if referring to the UI button.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#feature-names +level: warning +ignorecase: false +swap: + '[Tt]o [Dd]o [Ii]tems?': to-do item + '\w* [Aa] [Tt]o [Dd]o': Add a to do diff --git a/docs/.vale/gitlab/UnclearAntecedent.yml b/docs/.vale/gitlab/UnclearAntecedent.yml new file mode 100644 index 00000000..5f238598 --- /dev/null +++ b/docs/.vale/gitlab/UnclearAntecedent.yml @@ -0,0 +1,22 @@ +--- +# Warning: gitlab.UnclearAntecedent +# +# Checks for words that need a noun for clarity. +# +# For a list of all options, see https://docs.errata.ai/vale/styles +extends: existence +message: "'%s' is not precise. Try rewriting with a specific subject and verb." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#this-these-that-those +level: warning +ignorecase: false +tokens: + - 'That is' + - 'That was' + - 'These are' + - 'These were' + - 'There are' + - 'There were' + - 'This is' + - 'This was' + - 'Those are' + - 'Those were' diff --git a/docs/.vale/gitlab/Uppercase.yml b/docs/.vale/gitlab/Uppercase.yml new file mode 100644 index 00000000..dc05aa05 --- /dev/null +++ b/docs/.vale/gitlab/Uppercase.yml @@ -0,0 +1,252 @@ +--- +# Warning: gitlab.Uppercase +# +# Checks for use of all uppercase letters with unknown reason. +# +# For a list of all options, see https://docs.errata.ai/vale/styles. +extends: conditional +message: "'%s' is uppercase. Use lowercase or `backticks` if possible. Otherwise add this word to the rule's exception list." +link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-uppercase-acronym-test +level: warning +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - ACL + - AJAX + - AMI + - ANSI + - APAC + - API + - APM + - ARM + - ARN + - ASCII + - ASG + - AWS + - BMP + - BSD + - CAS + - CDN + - CGI + - CIDR + - CLI + - CNA + - CNCF + - CORE + - CORS + - CPU + - CRIME + - CRM + - CRUD + - CSRF + - CSS + - CSV + - CTE + - CWE + - CVE + - CVS + - CVSS + - DAG + - DAST + - DDL + - DHCP + - DML + - DNS + - DOM + - DORA + - DSA + - DSL + - DVCS + - DVD + - EBS + - ECDSA + - ECS + - EFS + - EKS + - ELB + - ENA + - EOL + - EWM + - EXIF + - FAQ + - FIDO + - FIFO + - FIPS + - FLAG + - FOSS + - FQDN + - FREE + - FTP + - GCP + - GDK + - GDPR + - GET + - GID + - GIF + - GKE + - GLEX + - GLFM + - GNU + - GPG + - GPL + - GPS + - GPT + - GPU + - GUI + - HAML + - HDD + - HEAD + - HIPAA + - HLL + - HSTS + - HTML + - HTTP + - HTTPS + - IAM + - IANA + - IBM + - ICO + - IDE + - IID + - IIS + - IMAP + - IOPS + - IRC + - ISO + - JPEG + - JPG + - JSON + - JVM + - JWT + - KICS + - LAN + - LDAP + - LDAPS + - LESS + - LFS + - LRU + - LSIF + - LTM + - LTS + - LVM + - MIME + - MIT + - MITRE + - MVC + - NAS + - NAT + - NDA + - NFS + - NGINX + - NOTE + - NPM + - NTP + - OKD + - ONLY + - OSS + - OTP + - OWASP + - PAT + - PCI-DSS + - PDF + - PEM + - PEP + - PGP + - PHP + - PID + - PKCS + - PNG + - POSIX + - POST + - PROXY + - PUT + - QPS + - RAID + - RAM + - RBAC + - RDP + - RDS + - RDS + - REST + - RFC + - RHEL + - RPC + - RPM + - RPS + - RSA + - RSS + - RTC + - RVM + - SAAS + - SAML + - SAN + - SAST + - SATA + - SBOM + - SCIM + - SCM + - SCP + - SCSS + - SDK + - SELF + - SEO + - SFTP + - SHA + - SKI + - SLA + - SLI + - SLO + - SMS + - SMTP + - SOAP + - SOC + - SOX + - SPDX + - SPDY + - SPF + - SQL + - SRE + - SSD + - SSG + - SSH + - SSL + - SSO + - STI + - SUSE + - SVG + - SVN + - TCP + - TIFF + - TIP + - TLD + - TLS + - TODO + - TOML + - TOTP + - TPS + - TTL + - UBI + - UDP + - UID + - UID + - UNIX + - URI + - URL + - USB + - UTC + - UTF + - UUID + - VCS + - VPC + - VPN + - WEBP + - WIP + - WSL + - XML + - XSS + - YAML + - ZAP + - ZIP diff --git a/docs/.vale/gitlab/VersionText.yml b/docs/.vale/gitlab/VersionText.yml new file mode 100644 index 00000000..571fba52 --- /dev/null +++ b/docs/.vale/gitlab/VersionText.yml @@ -0,0 +1,19 @@ +--- +# Error: gitlab.VersionText +# +# Checks that multi-line version text is formatted correctly. +# +# Specifically, looks for multi-line version text that doesn't use `-` to make it a list. +# For example: +# +# - `> Introduced in GitLab 14.0. +# - `> Removed in GitLab 15.0. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'This introduced-in section is not formatted correctly. Each entry must start with `> -` and long entries must be on one line.' +link: https://docs.gitlab.com/ee/development/documentation/versions.html +level: error +scope: raw +raw: + - '\n#.*\n\n> [^-].+\n[^\n`]' diff --git a/docs/.vale/gitlab/VersionTextSingleLine.yml b/docs/.vale/gitlab/VersionTextSingleLine.yml new file mode 100644 index 00000000..f76574bc --- /dev/null +++ b/docs/.vale/gitlab/VersionTextSingleLine.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.VersionTextSingleLine +# +# Verifies that single-item version notes don't have a hyphen. +# +# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +extends: existence +message: 'Version text with only a single item must not start with a hyphen.' +link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item +level: error +scope: raw +raw: + - '(\r|\n|\r\n){2}(> - .*)(\r|\n|\r\n){2}' diff --git a/docs/.vale/gitlab/Wordy.yml b/docs/.vale/gitlab/Wordy.yml new file mode 100644 index 00000000..7888d16d --- /dev/null +++ b/docs/.vale/gitlab/Wordy.yml @@ -0,0 +1,17 @@ +--- +# Suggestion: gitlab.Wordy +# +# Suggests shorter versions of wordy phrases. +# +# For a list of all options, see https://docs.errata.ai/vale/styles +extends: substitution +message: '%s "%s".' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: suggestion +ignorecase: true +swap: + in order to: "Be concise: use 'to' rather than" + needs? to: "Rewrite the sentence, or use 'must', instead of" + note that: "Be concise: rewrite the sentence to not use" + please: "Remove this word from the sentence: " + respectively: "Rewrite the sentence to be more precise, instead of using " diff --git a/docs/.vale/gitlab/spelling-exceptions.txt b/docs/.vale/gitlab/spelling-exceptions.txt new file mode 100644 index 00000000..5d268fdb --- /dev/null +++ b/docs/.vale/gitlab/spelling-exceptions.txt @@ -0,0 +1,879 @@ +accessor +accessors +Akismet +Alertmanager +Algolia +Alibaba +Aliyun +allowlist +allowlisted +allowlisting +allowlists +AlmaLinux +anonymization +anonymized +Ansible +Anthos +Apdex +Apparmor +approvers +architected +architecting +archiver +Arel +arity +Artifactory +Asana +Asciidoctor +asdf +Assembla +Atlassian +auditability +Auth0 +Authentiq +Authy +autocomplete +autocompleted +autocompletes +autocompleting +autogenerated +autoloaded +autoloader +autoloading +autoscale +autoscaled +autoscaler +autoscales +autoscaling +awardable +awardables +Axios +Ayoa +Azure +B-tree +backfilling +backport +backported +backporting +backports +backtrace +backtraced +backtraces +backtracing +badging +Bamboo +Bazel +Bhyve +Bitbucket +Bitnami +blockquote +blockquoted +blockquotes +blockquoting +boolean +booleans +Bootsnap +Bottlerocket +browsable +bugfix +bugfixed +bugfixes +bugfixing +Bugzilla +Buildkite +buildpack +buildpacks +bundler +bundlers +burndown +burnup +burstable +cacheable +Caddy +callstack +callstacks +Camo +canonicalization +canonicalized +captcha +Casdoor +CentOS +Ceph +Certbot +cgo +cgroup +cgroups +chai +changeset +changesets +ChaosKube +chatbot +chatbots +ChatOps +checksummed +checksumming +Chemlab +Citrix +Citus +clonable +Cloudwatch +Cobertura +Codeception +Codepen +Cognito +colocated +colocating +compilable +composable +composables +Conda +Consul +Contentful +Corosync +Coursier +cron +cronjob +cronjobs +crons +crontab +crontabs +crosslinked +crosslinking +crosslinks +Crossplane +Crowdin +CSV +customappsso +cybersecurity +Dangerfile +Datadog +datasource +datasources +datetime +Debian +Decompressor +decryptable +deduplicate +deduplicated +deduplicates +deduplicating +deduplication +deliverables +denormalize +denormalized +denormalizes +denormalizing +denylist +denylisted +denylisting +denylists +deployer +deployers +deprovision +deprovisioned +deprovisioning +deprovisions +dequarantine +dequarantined +dequarantining +deserialization +deserialize +deserializers +deserializes +DevOps +Dhall +disambiguates +discoverability +dismissable +Disqus +Distroless +Divio +Dockerfile +Dockerfiles +Dockerize +Dockerized +Dockerizing +dogfood +dogfooding +dogfoods +dotenv +downvoted +downvotes +Dpl +Dreamweaver +Ecto +ElastiCache +Elasticsearch +enablement +enqueued +enqueues +enum +enums +ETag +Excon +exfiltration +ExifTool +expirable +Facebook +failover +failovers +failsafe +Falco +falsy +Fargate +fastlane +Fastzip +favicon +favorited +Figma +Filebeat +Fio +firewalled +firewalling +fixup +Flawfinder +Flowdock +Fluentd +Flycheck +Forgerock +formatters +Fortinet +Fugit +fuzzer +Gantt +Gbps +Gemfile +Gemnasium +Gemojione +Getter +getters +Getters +gettext +Git +Gitaly +Gitea +GitHub +GitLab +gitlabsos +Gitleaks +Gitpod +Gitter +globals +Gmail +Godep +Gollum +Google +goroutine +goroutines +Gosec +Gradle +Grafana +Grafonnet +gravatar +Grype +Gzip +Hackathon +Haml +hardcode +hardcoded +hardcodes +Haswell +heatmap +heatmaps +Helm +Helmfile +Heroku +Herokuish +Hexo +HipChat +hostname +hostnames +hotfix +hotfixed +hotfixes +hotfixing +http +https +idempotence +idmapper +Iglu +Immer +inclusivity +Ingress +initializer +initializers +innersource +innersourcing +interdependencies +interdependency +interruptible +irker +issuables +Istio +Jaeger +jasmine-jquery +Javafuzz +JavaScript +Jenkins +Jenkinsfile +Jira +jq +jQuery +jsdom +Jsonnet +JupyterHub +Kaminari +kanban +kanbans +kaniko +Karma +Kerberos +Keycloak +keyset +keyspace +keytab +keytabs +Kibana +Kinesis +Klar +Knative +Kramdown +Kroki +Kubecost +kubectl +Kubernetes +Kubesec +Kustomize +Laravel +ldapsearch +Lefthook +Leiningen +libFuzzer +Libravatar +liveness +lockfiles +Lodash +Lograge +logrotate +Logrus +Logstash +lookahead +lookaheads +lookbehind +lookbehinds +lookups +loopback +Lucene +Maildir +Mailgun +Mailroom +Makefile +Makefiles +Markdown +markdownlint +Marketo +matcher +matchers +Matomo +Mattermost +mbox +memoization +memoize +memoized +memoizing +Memorystore +mergeability +mergeable +metaprogramming +Microsoft +middleware +middlewares +migratus +minikube +MinIO +misconfiguration +misconfigurations +misconfigure +misconfigured +misconfigures +misconfiguring +mitigations +mitmproxy +mixin +mixins +mockup +mockups +ModSecurity +Monokai +monorepo +monorepos +monospace +multiline +mutex +nameserver +nameservers +namespace +namespaced +namespaces +namespacing +namespacings +Nanoc +negatable +Netlify +Nokogiri +nosniff +noteable +noteables +npm +nullability +nullable +Nurtch +nyc +OAuth +Octokit +offboarded +offboarding +offboards +Okta +OmniAuth +onboarding +OpenID +OpenShift +Opsgenie +outdent +Overcommit +Packagist +parallelization +parallelizations +passwordless +Patroni +performant +PgBouncer +pgLoader +Phabricator +phaser +phasers +phpenv +pipenv +Pipfile +Pipfiles +Piwik +plaintext +Poedit +polyfill +polyfills +pooler +postfixed +postgres.ai +PostgreSQL +precompile +precompiled +preconfigure +preconfigured +preconfigures +prefill +prefilled +prefilling +prefills +preload +preloading +preloads +prepend +prepended +prepending +prepends +prepopulated +Prettifier +Pritaly +Priyanka +profiler +Prometheus +ProseMirror +protobuf +protobufs +proxied +proxies +proxyable +proxying +pseudocode +pseudonymization +pseudonymized +pseudonymizer +Puma +pytest +Python +Qualys +queryable +Quicktime +Rackspace +Raspbian +rbenv +rbtrace +Rclone +Rdoc +reachability +Realplayer +reauthenticate +reauthenticated +reauthenticates +reauthenticating +rebalancing +rebar +rebase +rebased +rebases +rebasing +reCAPTCHA +Redcarpet +redirection +redirections +Redis +Redmine +refactorings +referer +referers +reflog +reflogs +refspec +refspecs +reindex +reindexed +reindexes +reindexing +reinitialize +reinitializing +relicensing +remediations +renderers +replicables +repmgr +repmgrd +repurposing +requeue +requeued +requeues +requeuing +Restlet +resync +resynced +resyncing +resyncs +retarget +retargeted +retargeting +retargets +reusability +reverified +reverifies +reverify +roadmap +roadmaps +rollout +rollouts +rsync +rsynced +rsyncing +rsyncs +Rubinius +Rubix +RuboCop +Rubular +ruleset +rulesets +runbook +runbooks +runit +runtime +runtimes +Salesforce +sandboxing +sanitization +sbt +scalers +scatterplot +scatterplots +Schemastore +scrollable +Semgrep +Sendmail +Sentry +serializer +serializers +serializing +serverless +setuptools +severities +sharded +sharding +shfmt +Shimo +Shopify +Sidekiq +Silverlight +Sisense +Sitespeed +skippable +Slack +Slackbot +Slony +smartcard +smartcards +snapshotting +Snyk +Sobelow +Solargraph +Solarized +Sourcegraph +Spamcheck +spammable +sparkline +sparklines +spidering +Splunk +SpotBugs +Stackdriver +Stackprof +starrer +starrers +storable +storages +strace +strikethrough +strikethroughs +stunnel +stylelint +subchart +subcharts +subcommand +subcommands +subfolder +subfolders +subgraph +subgraphs +subgroup +subgroups +subkey +subkeys +sublicense +sublicensed +sublicenses +sublicensing +subnet +subnets +subnetting +subpath +subproject +subprojects +subqueried +subqueries +subquery +subquerying +substring +substrings +subtask +subtasks +subtest +subtests +subtree +subtrees +sudo +supercookie +supercookies +superset +supersets +supertype +supertypes +swappiness +swimlane +swimlanes +syncable +Sysbench +syscall +syscalls +syslog +systemd +tanuki +tcpdump +templated +Thanos +Thoughtbot +throughputs +Tiller +timebox +timeboxed +timeboxes +timeboxing +timecop +tiptap +todos +tokenizer +Tokenizers +tokenizing +tolerations +toolchain +toolchains +toolkit +toolkits +tooltip +tooltips +transactionally +transpile +transpiled +transpiles +transpiling +Trello +triaged +triages +triaging +Trivy +Truststore +truthy +Twilio +Twitter +TypeScript +Ubuntu +Udemy +unapplied +unapprove +unapproved +unapproving +unarchive +unarchived +unarchives +unarchiving +unary +unassign +unassigning +unassigns +unban +uncheck +unchecked +unchecking +unchecks +uncomment +uncommented +uncommenting +uncordon +unencode +unencoded +unencoder +unencodes +unencrypted +unfollow +unfollowed +unfollows +Unicorn +unindexed +unlink +unlinking +unlinks +unmappable +unmapped +unmergeable +unmerged +unmerges +unmerging +unmocked +unoptimize +unoptimized +unoptimizes +unoptimizing +unpatched +unprioritized +unprotect +unprotected +unprotecting +unprotects +unprovision +unprovisioned +unprovisions +unpublish +unpublished +unpublishes +unpublishing +unpushed +unreferenced +unregister +unregistered +unregisters +unreplicated +unresolve +unresolved +unresolving +unreviewed +unsanitized +unschedule +unscoped +unshare +unshared +unshares +unstage +unstaged +unstages +unstaging +unstar +unstars +unstarted +unstash +unstashed +unstashing +unsynced +unsynchronized +untarred +untracked +untrusted +unverified +unverifies +unverify +unverifying +uploader +uploaders +upstreams +upvote +upvoted +upvotes +URIs +Vagrantfile +validator +validators +vendored +vendoring +versionless +viewport +viewports +virtualized +virtualizing +Vue +Vuex +walkthrough +walkthroughs +WebdriverIO +Webex +webpack +webserver +Webservice +websocket +websockets +whitepaper +whitepapers +wireframe +wireframed +wireframes +wireframing +Wireshark +Wordpress +Workato +worktree +worktrees +Worldline +Xcode +Xeon +YouTrack +ytt +Yubico +Zabbix +Zeitwerk +Zendesk +ZenTao +zsh +Zstandard diff --git a/docs/.vale/vale.tmpl b/docs/.vale/vale.tmpl new file mode 100644 index 00000000..8a6c6e51 --- /dev/null +++ b/docs/.vale/vale.tmpl @@ -0,0 +1,51 @@ +{{- /* Modify Vale's output https://docs.errata.ai/vale/cli#--output */ -}} + +{{- /* Keep track of our various counts */ -}} + +{{- $e := 0 -}} +{{- $w := 0 -}} +{{- $s := 0 -}} +{{- $f := 0 -}} + +{{- /* Range over the linted files */ -}} + +{{- range .Files}} + +{{- $f = add1 $f -}} +{{- $path := .Path | underline -}} + +{{- /* Range over the file's alerts */ -}} + +{{- range .Alerts -}} + +{{- $error := "" -}} +{{- if eq .Severity "error" -}} + {{- $error = .Severity | red -}} + {{- $e = add1 $e -}} +{{- else if eq .Severity "warning" -}} + {{- $error = .Severity | yellow -}} + {{- $w = add1 $w -}} +{{- else -}} + {{- $error = .Severity | blue -}} + {{- $s = add1 $s -}} +{{- end}} + +{{- /* Variables setup */ -}} + +{{- $path = $path -}} +{{- $loc := printf "Line %d, position %d" .Line (index .Span 0) -}} +{{- $check := printf "%s" .Check -}} +{{- $message := printf "%s" .Message -}} +{{- $link := printf "%s" .Link -}} + +{{- /* Output */ -}} + +{{ $path }}: + {{ $loc }} (rule {{ $check }}) + {{ $error }}: {{ $message }} + More information: {{ $link }} + +{{end -}} +{{end -}} + +{{- $e}} {{"errors" | red}}, {{$w}} {{"warnings" | yellow}}, and {{$s}} {{"suggestions" | blue}} found. diff --git a/docs/README.md b/docs/README.md index 42faaea3..84181a3a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# DO NOT EDIT! +# DO NOT EDIT The docs for all commands including new commands are automatically generated. Do not change any file in this folder. @@ -8,6 +8,6 @@ Just add the commands and the docs will be generated If you add a new command or update the existing information for a command you need to generate the doc updates in your merge request. To generate the docs run the following command from the project directory: -```sh +```shell go run cmd/gen-docs/docs.go ``` diff --git a/docs/release_process.md b/docs/release_process.md index ce0b37c8..d380d799 100644 --- a/docs/release_process.md +++ b/docs/release_process.md @@ -5,18 +5,18 @@ You need to perform the following steps to release a new version of the cli. 1. Do a quick test of the cli in your local development. At this stage, you are only verifying there is no complete failure of the cli. 1. Tag the latest commit on `main` (e.g. `git tag v1.22.1`) 1. `git push origin main` and `git push --tags` -1. Manually add attribution to the changelog - you have to edit the release entry on the releases page https://gitlab.com/gitlab-org/cli/-/releases. +1. Manually add attribution to the changelog - you have to edit the release entry on the [releases page](https://gitlab.com/gitlab-org/cli/-/releases). ## Access to distribution channels -TODO: Here we'll add information about how we set up release for Homberew, WinGet and others: https://gitlab.com/groups/gitlab-org/-/epics/8251 +[TODO](https://gitlab.com/groups/gitlab-org/-/epics/8251): Here we'll add information about how we set up release for Homberew, WinGet and others. ## Setting up CI for releasing -For automated testing, you need to set up credentials for unit testing: https://gitlab.com/gitlab-org/cli/-/issues/1020 +For automated testing, you need to [set up credentials](https://gitlab.com/groups/gitlab-org/-/epics/8251) for unit testing. For releasing, you also need to add a `GITLAB_TOKEN_RELEASE`. This is how you create this token: -1. Go to Settings -> Access Tokens (https://gitlab.com/gitlab-org/cli/-/settings/access_tokens) +1. Go to Settings -> [Access Tokens](https://gitlab.com/gitlab-org/cli/-/settings/access_tokens) 1. Generate a new project token with `api` scope and `Maintainer` role. 1. Add the new token as `GITLAB_TOKEN_RELEASE` **protected** and **masked** CI variables. diff --git a/docs/security_releases.md b/docs/security_releases.md index d64391d9..29843f12 100644 --- a/docs/security_releases.md +++ b/docs/security_releases.md @@ -31,7 +31,7 @@ E --> F[push changes to the regular repo] Before starting, add the new `security` remote on your local GitLab repository: -```sh +```shell git remote add security git@gitlab.com:gitlab-org/security/cli.git ``` @@ -39,15 +39,15 @@ Finally, run the `scripts/security_harness` script. This script will install a G Please make sure the output of running `scripts/security-harness` is: -``` +```plaintext Pushing to remotes other than gitlab.com/gitlab-org/security has been disabled! ``` ### Request CVE number -For exploitable security issues, request a CVE number by [creating an issue in `gitlab-org/cves` project](https://gitlab.com/gitlab-org/cves/-/issues/new). **You can do the release before the CVE number is available.** When the CVE number is assigned, add it to the changelog entry[^1]. +For exploitable security issues, request a CVE number by [creating an issue in `gitlab-org/cves` project](https://gitlab.com/gitlab-org/cves/-/issues/new). **You can do the release before the CVE number is available.** When the CVE number is assigned, add it to the changelog entry. Here's an [example](https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/blob/main/CHANGELOG.md#security) from the VS Code Project. -Example CVE request: https://gitlab.com/gitlab-org/cves/-/issues/21 +[Example CVE request](https://gitlab.com/gitlab-org/cves/-/issues/21) ### Branches @@ -57,7 +57,7 @@ The main objective is to release the security fix as a patch of the latest produ Before starting the development of the fix, create a branch from the latest released tag. You can see the latest released tag on the [releases page](https://gitlab.com/gitlab-org/cli/-/releases). For example, if the latest release has a tag `v2.2.0` create a branch `security-2-2`. This is going to be the target of the security MRs. Push the branch to the security repo. -```sh +```shell git checkout v2.2.2 git checkout -b security-2-2 git push security security-2-2 @@ -67,7 +67,7 @@ git push security security-2-2 Your fix is going to be pushed into `security-` branch. If you work on issue #9999, you push the fix into `security-9999` branch. -```sh +```shell git checkout security-2-2 git checkout -b security-9999 git push security security-9999 @@ -86,7 +86,7 @@ Here, the process diverges from the [`gitlab-org/gitlab` security release proces Follow the [regular release process](release_process.md) to tag a new patch version on the `security-2-2` branch and release it. Patch release for tag `v2.2.0` would have version and tag `v2.2.1`. Push the tag to the security repo. -Validate that the security issue is fixed in in the released binary. +Validate that the security issue is fixed in the released binary. ### Backport the fix to `main` @@ -94,11 +94,9 @@ Validate that the security issue is fixed in in the released binary. 1. In the MR description, add references to all the reviewed MRs that were merged into `security-2-2`. 1. Review the MR and merge it. You don't need an additional reviewer because all of the changes have been reviewed. -Example in VS Code extension: https://gitlab.com/gitlab-org/security/gitlab-vscode-extension/-/merge_requests/8, TODO: replace with example from CLI +[Example in VS Code extension](https://gitlab.com/gitlab-org/security/gitlab-vscode-extension/-/merge_requests/8), TODO: replace with example from CLI ## Push changes back to the [CLI Repo](https://gitlab.com/gitlab-org/cli) 1. Push the patch tag to the [Cli Repo](https://gitlab.com/gitlab-org/cli) 1. Merge the [Security Repo](https://gitlab.com/gitlab-org/security/cli) `main` branch with the [Cli Repo](https://gitlab.com/gitlab-org/main) `main` and push to Cli Repo - -[^1]: Example from VS Code Extension project: [changelog entry](https://gitlab.com/gitlab-org/gitlab-vscode-extension/-/blob/main/CHANGELOG.md#security). diff --git a/docs/source/alias/delete.md b/docs/source/alias/delete.md index 1e0ad706..2e4b666a 100644 --- a/docs/source/alias/delete.md +++ b/docs/source/alias/delete.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab alias delete +# `glab alias delete` Delete an alias. @@ -17,9 +17,8 @@ Delete an alias. glab alias delete [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/alias/help.md b/docs/source/alias/help.md index 4cf49f88..09c53305 100644 --- a/docs/source/alias/help.md +++ b/docs/source/alias/help.md @@ -9,22 +9,16 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab alias help +# `glab alias help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type alias help [path to command] for full details. - ```plaintext glab alias help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/alias/index.md b/docs/source/alias/index.md index 676c75e8..34efece4 100755 --- a/docs/source/alias/index.md +++ b/docs/source/alias/index.md @@ -9,11 +9,11 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab alias +# `glab alias` Create, list and delete aliases -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -24,4 +24,3 @@ Create, list and delete aliases - [delete](delete.md) - [list](list.md) - [set](set.md) - diff --git a/docs/source/alias/list.md b/docs/source/alias/list.md index 91439e20..bc119d34 100644 --- a/docs/source/alias/list.md +++ b/docs/source/alias/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab alias list +# `glab alias list` List the available aliases. @@ -17,9 +17,8 @@ List the available aliases. glab alias list [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/alias/set.md b/docs/source/alias/set.md index 6cf4b86b..78f29bd7 100644 --- a/docs/source/alias/set.md +++ b/docs/source/alias/set.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab alias set +# `glab alias set` Set an alias. @@ -27,10 +27,9 @@ will not be automatically passed to the expanded expression. To have a shell ali arguments, you must explicitly accept them using "$1", "$2", etc., or "$@" to accept all of them. Platform note: on Windows, shell aliases are executed via "sh" as installed by Git For Windows. If -you have installed git on Windows in some other way, shell aliases may not work for you. +you have installed Git on Windows in some other way, shell aliases may not work for you. Quotes must always be used when defining a command as in the examples. - ```plaintext glab alias set '' [flags] ``` @@ -52,15 +51,14 @@ $ glab igrep user foo ``` -### Options +## Options ```plaintext -s, --shell Declare an alias to be passed through a shell interpreter ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/api/index.md b/docs/source/api/index.md index 7a51d7fb..975fa7d4 100755 --- a/docs/source/api/index.md +++ b/docs/source/api/index.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab api +# `glab api` Make an authenticated request to GitLab API @@ -17,17 +17,17 @@ Make an authenticated request to GitLab API Makes an authenticated HTTP request to the GitLab API and prints the response. The endpoint argument should either be a path of a GitLab API v4 endpoint, or -"graphql" to access the GitLab's GraphQL API. +"graphql" to access the GitLab GraphQL API. -GitLab REST API Docs: https://docs.gitlab.com/ce/api/README.html -GitLab GraphQL Docs: https://docs.gitlab.com/ee/api/graphql/ +- [GitLab REST API Docs](https://docs.gitlab.com/ee/api/index.html) +- [GitLab GraphQL Docs](https://docs.gitlab.com/ee/api/graphql/) -If the current directory is a git directory, the GitLab authenticated host in the current git -directory will be used else gitlab.com will be used. +If the current directory is a Git directory, the GitLab authenticated host in the current +directory will be used otherwise `gitlab.com` will be used. Override the GitLab hostname with '--hostname'. -Placeholder values ":fullpath" or ":id"", ":user" or ":username", ":group", ":namespace", -":repo", and ":branch" in the endpoint argument will get replaced with values from the +Placeholder values `:fullpath` or `:id`, `:user` or `:username`, `:group`, `:namespace`, +`:repo`, and `:branch` in the endpoint argument will get replaced with values from the repository of the current directory. The default HTTP request method is "GET" normally and "POST" if any parameters @@ -38,6 +38,7 @@ JSON-encoded string parameters to the POST body. The '--field' flag behaves like '--raw-field' with magic type conversion based on the format of the value: + - literal values "true", "false", "null", and integer numbers get converted to appropriate JSON types; - placeholder values ":namespace", ":repo", and ":branch" get populated with values @@ -109,7 +110,7 @@ $ glab api graphql --paginate -f query=' ``` -### Options +## Options ```plaintext -F, --field stringArray Add a parameter of inferred type @@ -123,9 +124,8 @@ $ glab api graphql --paginate -f query=' --silent Do not print the response body ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/auth/git-credential.md b/docs/source/auth/git-credential.md index 2adb8d51..dc368023 100644 --- a/docs/source/auth/git-credential.md +++ b/docs/source/auth/git-credential.md @@ -9,17 +9,16 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab auth git-credential +# `glab auth git-credential` -Implements git credential helper manager +Implements Git credential helper manager ```plaintext glab auth git-credential [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/auth/help.md b/docs/source/auth/help.md index 0fbc821d..61f49d64 100644 --- a/docs/source/auth/help.md +++ b/docs/source/auth/help.md @@ -9,22 +9,16 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab auth help +# `glab auth help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type auth help [path to command] for full details. - ```plaintext glab auth help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/auth/index.md b/docs/source/auth/index.md index 571160d8..e85579a4 100755 --- a/docs/source/auth/index.md +++ b/docs/source/auth/index.md @@ -9,11 +9,11 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab auth +# `glab auth` Manage glab's authentication state -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -24,4 +24,3 @@ Manage glab's authentication state - [git-credential](git-credential.md) - [login](login.md) - [status](status.md) - diff --git a/docs/source/auth/login.md b/docs/source/auth/login.md index e76140f8..676b4b5f 100644 --- a/docs/source/auth/login.md +++ b/docs/source/auth/login.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab auth login +# `glab auth login` Authenticate with a GitLab instance @@ -17,8 +17,7 @@ Authenticate with a GitLab instance Authenticate with a GitLab instance. You can pass in a token on standard input by using `--stdin`. -The minimum required scopes for the token are: "api", "write_repository". - +The minimum required scopes for the token are: `api`, `write_repository`. ```plaintext glab auth login [flags] @@ -29,14 +28,14 @@ glab auth login [flags] ```plaintext # start interactive setup $ glab auth login -# authenticate against gitlab.com by reading the token from a file +# authenticate against `gitlab.com` by reading the token from a file $ glab auth login --stdin < myaccesstoken.txt # authenticate with a self-hosted GitLab instance $ glab auth login --hostname salsa.debian.org ``` -### Options +## Options ```plaintext -h, --hostname string The hostname of the GitLab instance to authenticate with @@ -44,9 +43,8 @@ $ glab auth login --hostname salsa.debian.org -t, --token string Your GitLab access token ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/auth/status.md b/docs/source/auth/status.md index b6d86323..0ea30af0 100644 --- a/docs/source/auth/status.md +++ b/docs/source/auth/status.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab auth status +# `glab auth status` View authentication status @@ -19,21 +19,19 @@ Verifies and displays information about your authentication state. This command tests the authentication states of all known GitLab instances in the config file and reports issues if any - ```plaintext glab auth status [flags] ``` -### Options +## Options ```plaintext -h, --hostname string Check a specific instance's authentication status -t, --show-token Display the auth token ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/check-update/index.md b/docs/source/check-update/index.md index a8a0e6de..a676f011 100755 --- a/docs/source/check-update/index.md +++ b/docs/source/check-update/index.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab check-update +# `glab check-update` Check for latest glab releases @@ -17,9 +17,8 @@ Check for latest glab releases glab check-update [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/ci/artifact.md b/docs/source/ci/artifact.md index 32e52982..327802d2 100644 --- a/docs/source/ci/artifact.md +++ b/docs/source/ci/artifact.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci artifact +# `glab ci artifact` Download all Artifacts from the last pipeline @@ -20,21 +20,20 @@ glab ci artifact [flags] ## Examples ```plaintext -$ glab ci artifact main build -$ glab ci artifact main deploy --path="artifacts/" +glab ci artifact main build +glab ci artifact main deploy --path="artifacts/" ``` -### Options +## Options ```plaintext -p, --path string Path to download the Artifact files (default ./) ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/ci.md b/docs/source/ci/ci.md index 72af1bf9..c733a952 100644 --- a/docs/source/ci/ci.md +++ b/docs/source/ci/ci.md @@ -9,18 +9,18 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci ci +# `glab ci ci` Work with GitLab CI pipelines and jobs ## Examples ```plaintext -$ glab pipeline ci trace +glab pipeline ci trace ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -32,4 +32,3 @@ $ glab pipeline ci trace - [lint](lint.md) - [trace](trace.md) - [view](view.md) - diff --git a/docs/source/ci/delete.md b/docs/source/ci/delete.md index b442c407..d7529ee7 100644 --- a/docs/source/ci/delete.md +++ b/docs/source/ci/delete.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci delete +# `glab ci delete` Delete a CI pipeline @@ -20,21 +20,20 @@ glab ci delete [flags] ## Examples ```plaintext -$ glab ci delete 34 -$ glab ci delete 12,34,2 +glab ci delete 34 +glab ci delete 12,34,2 ``` -### Options +## Options ```plaintext -s, --status string delete pipelines by status: {running|pending|success|failed|canceled|skipped|created|manual} ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/help.md b/docs/source/ci/help.md index 6f074fd0..a84edd22 100644 --- a/docs/source/ci/help.md +++ b/docs/source/ci/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci help +# `glab ci help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type ci help [path to command] for full details. - ```plaintext glab ci help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/index.md b/docs/source/ci/index.md index 7b307ee0..c672d9ac 100755 --- a/docs/source/ci/index.md +++ b/docs/source/ci/index.md @@ -9,17 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci +# `glab ci` Work with GitLab CI pipelines and jobs -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -37,4 +37,3 @@ Work with GitLab CI pipelines and jobs - [status](status.md) - [trace](trace.md) - [view](view.md) - diff --git a/docs/source/ci/lint.md b/docs/source/ci/lint.md index ede1ffb0..4923a282 100644 --- a/docs/source/ci/lint.md +++ b/docs/source/ci/lint.md @@ -9,9 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci lint +# `glab ci lint` -Checks if your .gitlab-ci.yml file is valid. +Checks if your `.gitlab-ci.yml` file is valid. ```plaintext glab ci lint [flags] @@ -29,10 +29,9 @@ $ glab ci lint path/to/.gitlab-ci.yml ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/list.md b/docs/source/ci/list.md index a48277a4..d5fa6867 100644 --- a/docs/source/ci/list.md +++ b/docs/source/ci/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci list +# `glab ci list` Get the list of CI pipelines @@ -20,12 +20,12 @@ glab ci list [flags] ## Examples ```plaintext -$ glab ci list -$ glab ci list --status=failed +glab ci list +glab ci list --status=failed ``` -### Options +## Options ```plaintext -o, --orderBy string Order pipeline by @@ -35,10 +35,9 @@ $ glab ci list --status=failed -s, --status string Get pipeline with status: {running|pending|success|failed|canceled|skipped|created|manual} ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/retry.md b/docs/source/ci/retry.md index 0333f89a..7b0d5484 100644 --- a/docs/source/ci/retry.md +++ b/docs/source/ci/retry.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci retry +# `glab ci retry` Retry a CI job @@ -20,14 +20,13 @@ glab ci retry [flags] ## Examples ```plaintext -$ glab ci retry 871528 +glab ci retry 871528 ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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.md b/docs/source/ci/run.md index 1465e1b3..d07dc531 100644 --- a/docs/source/ci/run.md +++ b/docs/source/ci/run.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci run +# `glab ci run` Create or run a new CI pipeline @@ -20,24 +20,23 @@ glab ci run [flags] ## Examples ```plaintext -$ glab ci run -$ glab ci run -b main -$ glab ci run -b main --variables MYKEY:some_value - $ glab ci run -b main --variables MYKEY:some_value --variables KEY2:another_value +glab ci run +glab ci run -b main +glab ci run -b main --variables MYKEY:some_value +glab ci run -b main --variables MYKEY:some_value --variables KEY2:another_value ``` -### Options +## Options ```plaintext -b, --branch string Create pipeline on branch/ref --variables strings Pass variables to pipeline ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/status.md b/docs/source/ci/status.md index 2c035ac1..b454b4ab 100644 --- a/docs/source/ci/status.md +++ b/docs/source/ci/status.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci status +# `glab ci status` View a running CI pipeline on current or other branch specified @@ -20,14 +20,14 @@ glab ci status [flags] ## Examples ```plaintext -$ glab ci status --live -$ glab ci status --compact // more compact view -$ glab ci status --branch=master // Get pipeline for master branch -$ glab ci status // Get pipeline for current branch +glab ci status --live +glab ci status --compact // more compact view +glab ci status --branch=master // Get pipeline for master branch +glab ci status // Get pipeline for current branch ``` -### Options +## Options ```plaintext -b, --branch string Check pipeline status for a branch. (Default is current branch) @@ -35,10 +35,9 @@ $ glab ci status // Get pipeline for current branch -l, --live Show status in real-time till pipeline ends ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/trace.md b/docs/source/ci/trace.md index a460d26b..4c2961ab 100644 --- a/docs/source/ci/trace.md +++ b/docs/source/ci/trace.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci trace +# `glab ci trace` Trace a CI job log in real time @@ -28,16 +28,15 @@ $ glab ci trace 224356863 ``` -### Options +## Options ```plaintext -b, --branch string Check pipeline status for a branch. (Default is the current branch) ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/view.md b/docs/source/ci/view.md index 47f0de4b..36b4f921 100644 --- a/docs/source/ci/view.md +++ b/docs/source/ci/view.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ci view +# `glab ci view` View, run, trace/logs, and cancel CI jobs current pipeline @@ -24,8 +24,7 @@ Use arrow keys to navigate jobs and logs. 'Ctrl+C' to cancel job -- (Quits CI view if selected job isn't running or pending). 'Ctrl+Q' to Quit CI View. 'Ctrl+Space' suspend application and view logs (similar to glab pipeline ci trace) -Supports vi style (hjkl,Gg) bindings and arrow keys for navigating jobs and logs. - +Supports vi style bindings and arrow keys for navigating jobs and logs. ```plaintext glab ci view [branch/tag] [flags] @@ -34,23 +33,22 @@ glab ci view [branch/tag] [flags] ## Examples ```plaintext -$ glab pipeline ci view # Uses current branch -$ glab pipeline ci view master # Get latest pipeline on master branch -$ glab pipeline ci view -b master # just like the second example -$ glab pipeline ci view -b master -R profclems/glab # Get latest pipeline on master branch of profclems/glab repo +glab pipeline ci view # Uses current branch +glab pipeline ci view master # Get latest pipeline on master branch +glab pipeline ci view -b master # just like the second example +glab pipeline ci view -b master -R profclems/glab # Get latest pipeline on master branch of profclems/glab repo ``` -### Options +## Options ```plaintext -b, --branch string Check pipeline status for a branch/tag. (Default is the current branch) ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/completion/index.md b/docs/source/completion/index.md index ccd737b4..e31c7f77 100755 --- a/docs/source/completion/index.md +++ b/docs/source/completion/index.md @@ -9,48 +9,51 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab completion +# `glab completion` Generate shell completion scripts ## Synopsis -Generate shell completion scripts for glab commands. +The output of this command will be computer code and is meant to be saved +to a file or immediately evaluated by an interactive shell. -The output of this command will be computer code and is meant to be saved to a -file or immediately evaluated by an interactive shell. +For example, for bash you could add this to your `~/.bash_profile`: -For example, for bash you could add this to your '~/.bash_profile': +```plaintext +eval "$(glab completion -s bash)" +``` - eval "$(glab completion -s bash)" +Generate a `_glab` completion script and put it somewhere in your `$fpath`: -Generate a %[1]s_glab%[1]s completion script and put it somewhere in your %[1]s$fpath%[1]s: - glab completion -s zsh > /usr/local/share/zsh/site-functions/_glab - Ensure that the following is present in your %[1]s~/.zshrc%[1]s: - autoload -U compinit - compinit -i - - Zsh version 5.7 or later is recommended. +```plaintext +glab completion -s zsh > /usr/local/share/zsh/site-functions/_glab +``` + +Ensure that the following is present in your `~/.zshrc`: + +- `autoload -U compinit` +- `compinit -i` + +Zsh version 5.7 or later is recommended. When installing glab through a package manager, however, it's possible that no additional shell configuration is necessary to gain completion support. For Homebrew, see - ```plaintext glab completion [flags] ``` -### Options +## Options ```plaintext --no-desc Do not include shell completion description -s, --shell string Shell type: {bash|zsh|fish|powershell} (default "bash") ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/config/get.md b/docs/source/config/get.md index 0063a49f..cd5ce56a 100644 --- a/docs/source/config/get.md +++ b/docs/source/config/get.md @@ -9,13 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab config get +# `glab config get` -Prints the value of a given configuration key - -## Synopsis - -Get the value for a given configuration key. +Prints the value of a given configuration key. ```plaintext glab config get [flags] @@ -32,16 +28,15 @@ glab config get [flags] ``` -### Options +## Options ```plaintext -g, --global Read from global config file (~/.config/glab-cli/config.yml). [Default: looks through Environment variables → Local → Global] -h, --host string Get per-host setting ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/config/help.md b/docs/source/config/help.md index ff7114c1..b38f4f36 100644 --- a/docs/source/config/help.md +++ b/docs/source/config/help.md @@ -9,22 +9,16 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab config help +# `glab config help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type config help [path to command] for full details. - ```plaintext glab config help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/config/index.md b/docs/source/config/index.md index b0a82d2e..c83ad2dd 100755 --- a/docs/source/config/index.md +++ b/docs/source/config/index.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab config +# `glab config` Set and get glab settings @@ -19,22 +19,21 @@ Get and set key/value strings. Current respected settings: -- token: Your gitlab access token, defaults to environment variables -- gitlab_uri: if unset, defaults to https://gitlab.com +- token: Your GitLab access token, defaults to environment variables +- gitlab_uri: if unset, defaults to `https://gitlab.com` - browser: if unset, defaults to environment variables - editor: if unset, defaults to environment variables. - visual: alternative for editor. if unset, defaults to environment variables. -- glamour_style: Your desired markdown renderer style. Options are dark, light, notty. Custom styles are allowed set a custom style https://github.com/charmbracelet/glamour#styles +- glamour_style: Your desired Markdown renderer style. Options are dark, light, notty. Custom styles are allowed using [glamour](https://github.com/charmbracelet/glamour#styles) - glab_pager: Your desired pager command to use (e.g. less -R) - -### Options +## Options ```plaintext -g, --global use global config file ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -45,4 +44,3 @@ Current respected settings: - [get](get.md) - [init](init.md) - [set](set.md) - diff --git a/docs/source/config/init.md b/docs/source/config/init.md index cd1d110e..aa1efbdc 100644 --- a/docs/source/config/init.md +++ b/docs/source/config/init.md @@ -9,25 +9,27 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab config init +# `glab config init` Shows a prompt to set basic glab configuration ## Synopsis Update the configuration by setting a key to a value. -Examples: - $ glab config init - ? Enter default Gitlab Host (Current Value: https://gitlab.com): | +Examples: + +```plaintext +$ glab config init +? Enter default GitLab Host (Current Value: https://gitlab.com): +``` ```plaintext glab config init [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/config/set.md b/docs/source/config/set.md index b7fb05ec..28351c81 100644 --- a/docs/source/config/set.md +++ b/docs/source/config/set.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab config set +# `glab config set` Updates configuration with the value of a given key @@ -19,7 +19,6 @@ Update the configuration by setting a key to a value. Use glab config set --global if you want to set a global config. Specifying the --hostname flag also saves in the global config file - ```plaintext glab config set [flags] ``` @@ -28,21 +27,20 @@ glab config set [flags] ```plaintext - $ glab config set editor vim - $ glab config set token xxxxx -h gitlab.com + glab config set editor vim + glab config set token xxxxx -h gitlab.com ``` -### Options +## Options ```plaintext -g, --global write to global ~/.config/glab-cli/config.yml file rather than the repository .glab-cli/config/config -h, --host string Set per-host setting ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/index.md b/docs/source/index.md index 9787922c..2f93ddce 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,38 +1,37 @@ # GLab - A GitLab CLI Tool -GLab is an open source Gitlab Cli tool written in Go (golang) to help -work seamlessly with Gitlab from the command line. Work with issues, +GLab is an open source GitLab Cli tool written in Go (golang) to help +work seamlessly with GitLab from the command line. Work with issues, merge requests, **watch running pipelines directly from your CLI** among other features. ## Usage -``` +```plaintext glab [flags] ``` ## Core Commands - -- ``glab mr [list, create, close, reopen, delete, ...]`` -- ``glab issue [list, create, close, reopen, delete, ...]`` -- ``glab pipeline [list, delete, ci status, ci view, ...]`` -- ``glab release`` -- ``glab repo`` -- ``glab label`` -- ``glab alias`` +- `glab mr [list, create, close, reopen, delete, ...]` +- `glab issue [list, create, close, reopen, delete, ...]` +- `glab pipeline [list, delete, ci status, ci view, ...]` +- `glab release` +- `glab repo` +- `glab label` +- `glab alias` ### Examples -``` -$ glab auth login --stdin < token.txt -$ glab issue list -$ glab mr for 123 # Create merge request for issue 123 -$ glab mr checkout 243 -$ glab pipeline ci view -$ glab mr view -$ glab mr approve -$ glab mr merge +```plaintext +glab auth login --stdin < token.txt +glab issue list +glab mr for 123 # Create merge request for issue 123 +glab mr checkout 243 +glab pipeline ci view +glab mr view +glab mr approve +glab mr merge ``` ## Installation diff --git a/docs/source/issue/board.md b/docs/source/issue/board.md index f67d68cc..49f778ba 100644 --- a/docs/source/issue/board.md +++ b/docs/source/issue/board.md @@ -9,11 +9,11 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue board +# `glab issue board` Work with GitLab Issue Boards in the given project. -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -24,4 +24,3 @@ Work with GitLab Issue Boards in the given project. - [create](create.md) - [view](view.md) - diff --git a/docs/source/issue/close.md b/docs/source/issue/close.md index a4694d0f..ba4f9576 100644 --- a/docs/source/issue/close.md +++ b/docs/source/issue/close.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue close +# `glab issue close` Close an issue @@ -20,15 +20,14 @@ glab issue close [flags] ## Examples ```plaintext -$ glab issue close 123 -$ glab issue close https://gitlab.com/profclems/glab/-/issues/123 +glab issue close 123 +glab issue close https://gitlab.com/profclems/glab/-/issues/123 ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/create.md b/docs/source/issue/create.md index 0638d038..161341f3 100644 --- a/docs/source/issue/create.md +++ b/docs/source/issue/create.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue create +# `glab issue create` Create an issue @@ -20,15 +20,15 @@ glab issue create [flags] ## Examples ```plaintext -$ glab issue create -$ glab issue new -$ glab issue create -m release-2.0.0 -t "we need this feature" --label important -$ glab issue new -t "Fix CVE-YYYY-XXXX" -l security --linked-mr 123 -$ glab issue create -m release-1.0.1 -t "security fix" --label security --web +glab issue create +glab issue new +glab issue create -m release-2.0.0 -t "we need this feature" --label important +glab issue new -t "Fix CVE-YYYY-XXXX" -l security --linked-mr 123 +glab issue create -m release-1.0.1 -t "security fix" --label security --web ``` -### Options +## Options ```plaintext -a, --assignee usernames Assign issue to people by their usernames @@ -48,10 +48,9 @@ $ glab issue create -m release-1.0.1 -t "security fix" --label security --web -y, --yes Don't prompt for confirmation to submit the issue ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/delete.md b/docs/source/issue/delete.md index c5100e67..32a7a7a9 100644 --- a/docs/source/issue/delete.md +++ b/docs/source/issue/delete.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue delete +# `glab issue delete` Delete an issue @@ -20,16 +20,15 @@ glab issue delete [flags] ## Examples ```plaintext -$ glab issue delete 123 -$ glab issue del 123 -$ glab issue delete https://gitlab.com/profclems/glab/-/issues/123 +glab issue delete 123 +glab issue del 123 +glab issue delete https://gitlab.com/profclems/glab/-/issues/123 ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/help.md b/docs/source/issue/help.md index c024430e..bb07719e 100644 --- a/docs/source/issue/help.md +++ b/docs/source/issue/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue help +# `glab issue help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type issue help [path to command] for full details. - ```plaintext glab issue help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/index.md b/docs/source/issue/index.md index 8d358b2d..3bcca816 100755 --- a/docs/source/issue/index.md +++ b/docs/source/issue/index.md @@ -9,27 +9,27 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue +# `glab issue` Work with GitLab issues ## Examples ```plaintext -$ glab issue list -$ glab issue create --label --confidential -$ glab issue view --web -$ glab issue note -m "closing because !123 was merged" +glab issue list +glab issue create --label --confidential +glab issue view --web +glab issue note -m "closing because !123 was merged" ``` -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -48,4 +48,3 @@ $ glab issue note -m "closing because !123 was merged" - [unsubscribe](unsubscribe.md) - [update](update.md) - [view](view.md) - diff --git a/docs/source/issue/list.md b/docs/source/issue/list.md index acb3fcc1..9a61609e 100644 --- a/docs/source/issue/list.md +++ b/docs/source/issue/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue list +# `glab issue list` List project issues @@ -20,14 +20,14 @@ glab issue list [flags] ## Examples ```plaintext -$ glab issue list --all -$ glab issue ls --all -$ glab issue list --mine -$ glab issue list --milestone release-2.0.0 --opened +glab issue list --all +glab issue ls --all +glab issue list --mine +glab issue list --milestone release-2.0.0 --opened ``` -### Options +## Options ```plaintext -A, --all Get all issues @@ -47,10 +47,9 @@ $ glab issue list --milestone release-2.0.0 --opened --search string Search in the fields defined by --in ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/note.md b/docs/source/issue/note.md index c79f91ba..391b1356 100644 --- a/docs/source/issue/note.md +++ b/docs/source/issue/note.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue note +# `glab issue note` Add a comment or note to an issue on GitLab @@ -17,16 +17,15 @@ Add a comment or note to an issue on GitLab glab issue note [flags] ``` -### Options +## Options ```plaintext -m, --message string Comment/Note message ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/reopen.md b/docs/source/issue/reopen.md index 64e49f00..fc28b364 100644 --- a/docs/source/issue/reopen.md +++ b/docs/source/issue/reopen.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue reopen +# `glab issue reopen` Reopen a closed issue @@ -20,16 +20,15 @@ glab issue reopen [flags] ## Examples ```plaintext -$ glab issue reopen 123 -$ glab issue open 123 -$ glab issue reopen https://gitlab.com/profclems/glab/-/issues/123 +glab issue reopen 123 +glab issue open 123 +glab issue reopen https://gitlab.com/profclems/glab/-/issues/123 ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/subscribe.md b/docs/source/issue/subscribe.md index 9f34978e..c5bdee9b 100644 --- a/docs/source/issue/subscribe.md +++ b/docs/source/issue/subscribe.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue subscribe +# `glab issue subscribe` Subscribe to an issue @@ -20,16 +20,15 @@ glab issue subscribe [flags] ## Examples ```plaintext -$ glab issue subscribe 123 -$ glab issue sub 123 -$ glab issue subscribe https://gitlab.com/profclems/glab/-/issues/123 +glab issue subscribe 123 +glab issue sub 123 +glab issue subscribe https://gitlab.com/profclems/glab/-/issues/123 ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/unsubscribe.md b/docs/source/issue/unsubscribe.md index 85a2cd03..baf0a752 100644 --- a/docs/source/issue/unsubscribe.md +++ b/docs/source/issue/unsubscribe.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue unsubscribe +# `glab issue unsubscribe` Unsubscribe to an issue @@ -20,16 +20,15 @@ glab issue unsubscribe [flags] ## Examples ```plaintext -$ glab issue unsubscribe 123 -$ glab issue unsub 123 -$ glab issue unsubscribe https://gitlab.com/profclems/glab/-/issues/123 +glab issue unsubscribe 123 +glab issue unsub 123 +glab issue unsubscribe https://gitlab.com/profclems/glab/-/issues/123 ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/update.md b/docs/source/issue/update.md index 141edf7e..d70b1493 100644 --- a/docs/source/issue/update.md +++ b/docs/source/issue/update.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue update +# `glab issue update` Update issue @@ -20,12 +20,12 @@ glab issue update [flags] ## Examples ```plaintext -$ glab issue update 42 --label ui,ux -$ glab issue update 42 --unlabel working +glab issue update 42 --label ui,ux +glab issue update 42 --unlabel working ``` -### Options +## Options ```plaintext -a, --assignee strings assign users via username, prefix with '!' or '-' to remove from existing assignees, '+' to add, otherwise replace existing assignees with given users @@ -41,10 +41,9 @@ $ glab issue update 42 --unlabel working --unlock-discussion Unlock discussion on issue ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/issue/view.md b/docs/source/issue/view.md index a3975281..aea93bb6 100644 --- a/docs/source/issue/view.md +++ b/docs/source/issue/view.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab issue view +# `glab issue view` Display the title, body, and other information about an issue. @@ -20,15 +20,15 @@ glab issue view [flags] ## Examples ```plaintext -$ glab issue view 123 -$ glab issue show 123 -$ glab issue view --web 123 -$ glab issue view --comments 123 -$ glab issue view https://gitlab.com/profclems/glab/-/issues/123 +glab issue view 123 +glab issue show 123 +glab issue view --web 123 +glab issue view --comments 123 +glab issue view https://gitlab.com/profclems/glab/-/issues/123 ``` -### Options +## Options ```plaintext -c, --comments Show issue comments and activities @@ -38,10 +38,9 @@ $ glab issue view https://gitlab.com/profclems/glab/-/issues/123 -w, --web Open issue in a browser. Uses default browser or browser specified in BROWSER variable ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/label/create.md b/docs/source/label/create.md index 09bb36f8..1088a2cd 100644 --- a/docs/source/label/create.md +++ b/docs/source/label/create.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab label create +# `glab label create` Create labels for repository/project @@ -20,13 +20,13 @@ glab label create [flags] ## Examples ```plaintext -$ glab label create -$ glab label new -$ glab label create -R owner/repo +glab label create +glab label new +glab label create -R owner/repo ``` -### Options +## Options ```plaintext -c, --color string Color of label in plain or HEX code. (Default: #428BCA) (default "#428BCA") @@ -34,10 +34,9 @@ $ glab label create -R owner/repo -n, --name string Name of label ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/label/help.md b/docs/source/label/help.md index d2a529ed..8f4e044a 100644 --- a/docs/source/label/help.md +++ b/docs/source/label/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab label help +# `glab label help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type label help [path to command] for full details. - ```plaintext glab label help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/label/index.md b/docs/source/label/index.md index e61e76f2..6c335262 100755 --- a/docs/source/label/index.md +++ b/docs/source/label/index.md @@ -9,17 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab label +# `glab label` Manage labels on remote -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -29,4 +29,3 @@ Manage labels on remote - [create](create.md) - [list](list.md) - diff --git a/docs/source/label/list.md b/docs/source/label/list.md index d247ae95..85f5303f 100644 --- a/docs/source/label/list.md +++ b/docs/source/label/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab label list +# `glab label list` List labels in repository @@ -20,23 +20,22 @@ glab label list [flags] ## Examples ```plaintext -$ glab label list -$ glab label ls -$ glab label list -R owner/repository +glab label list +glab label ls +glab label list -R owner/repository ``` -### Options +## Options ```plaintext -p, --page int Page number (default 1) -P, --per-page int Number of items to list per page (default 30) ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/approve.md b/docs/source/mr/approve.md index a52cf4ff..6ed817ca 100644 --- a/docs/source/mr/approve.md +++ b/docs/source/mr/approve.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr approve +# `glab mr approve` Approve merge requests @@ -20,24 +20,23 @@ glab mr approve { | } [flags] ## Examples ```plaintext -$ glab mr approve 235 -$ glab mr approve 123 345 -$ glab mr approve branch-1 -$ glab mr approve branch-2 branch-3 -$ glab mr approve # Finds open merge request from current branch +glab mr approve 235 +glab mr approve 123 345 +glab mr approve branch-1 +glab mr approve branch-2 branch-3 +glab mr approve # Finds open merge request from current branch ``` -### Options +## Options ```plaintext -s, --sha string SHA which must match the SHA of the HEAD commit of the merge request ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/approvers.md b/docs/source/mr/approvers.md index 192db81c..1a49ddf8 100644 --- a/docs/source/mr/approvers.md +++ b/docs/source/mr/approvers.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr approvers +# `glab mr approvers` List eligible approvers for merge requests in any state @@ -17,10 +17,9 @@ List eligible approvers for merge requests in any state glab mr approvers [ | ] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/checkout.md b/docs/source/mr/checkout.md index cf4aff6e..d5362dd4 100644 --- a/docs/source/mr/checkout.md +++ b/docs/source/mr/checkout.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr checkout +# `glab mr checkout` Checkout to an open merge request @@ -20,15 +20,15 @@ glab mr checkout [ | ] [flags] ## Examples ```plaintext -$ glab mr checkout 1 -$ glab mr checkout branch --track -$ glab mr checkout 12 --branch todo-fix -$ glab mr checkout new-feature --set-upstream-to=upstream/main -$ glab mr checkout # use checked out branch +glab mr checkout 1 +glab mr checkout branch --track +glab mr checkout 12 --branch todo-fix +glab mr checkout new-feature --set-upstream-to=upstream/main +glab mr checkout # use checked out branch ``` -### Options +## Options ```plaintext -b, --branch string checkout merge request with name @@ -36,10 +36,9 @@ $ glab mr checkout # use checked out branch -t, --track set checked out branch to track remote branch, adds remote if needed ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/close.md b/docs/source/mr/close.md index 33e5892d..f3bea140 100644 --- a/docs/source/mr/close.md +++ b/docs/source/mr/close.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr close +# `glab mr close` Close merge requests @@ -20,19 +20,18 @@ glab mr close [ | ] [flags] ## Examples ```plaintext -$ glab mr close 1 -$ glab mr close 1 2 3 4 # close multiple branches at once -$ glab mr close # use checked out branch -$ glab mr close branch -$ glab mr close username:branch -$ glab mr close branch -R another/repo +glab mr close 1 +glab mr close 1 2 3 4 # close multiple branches at once +glab mr close # use checked out branch +glab mr close branch +glab mr close username:branch +glab mr close branch -R another/repo ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/create.md b/docs/source/mr/create.md index 06ad8b47..cff224a3 100644 --- a/docs/source/mr/create.md +++ b/docs/source/mr/create.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr create +# `glab mr create` Create new merge request @@ -20,15 +20,15 @@ glab mr create [flags] ## Examples ```plaintext -$ glab mr new -$ glab mr create -a username -t "fix annoying bug" -$ glab mr create -f --draft --label RFC -$ glab mr create --fill --yes --web -$ glab mr create --fill --fill-commit-body --yes +glab mr new +glab mr create -a username -t "fix annoying bug" +glab mr create -f --draft --label RFC +glab mr create --fill --yes --web +glab mr create --fill --fill-commit-body --yes ``` -### Options +## Options ```plaintext --allow-collaboration Allow commits from other members @@ -56,10 +56,9 @@ $ glab mr create --fill --fill-commit-body --yes -y, --yes Skip submission confirmation prompt, with --fill it skips all optional prompts ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/delete.md b/docs/source/mr/delete.md index e15aea7d..fec0c99b 100644 --- a/docs/source/mr/delete.md +++ b/docs/source/mr/delete.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr delete +# `glab mr delete` Delete merge requests @@ -20,18 +20,17 @@ glab mr delete [ | ] [flags] ## Examples ```plaintext -$ glab mr delete 123 -$ glab mr delete 123 branch-name 789 # close multiple branches -$ glab mr delete 1,2,branch-related-to-mr-3,4,5 # close MRs !1,!2,!3,!4,!5 -$ glab mr del 123 -$ glab mr delete branch +glab mr delete 123 +glab mr delete 123 branch-name 789 # close multiple branches +glab mr delete 1,2,branch-related-to-mr-3,4,5 # close MRs !1,!2,!3,!4,!5 +glab mr del 123 +glab mr delete branch ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/diff.md b/docs/source/mr/diff.md index 0db01cf1..d2eeafff 100644 --- a/docs/source/mr/diff.md +++ b/docs/source/mr/diff.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr diff +# `glab mr diff` View changes in a merge request @@ -20,23 +20,22 @@ glab mr diff [ | ] [flags] ## Examples ```plaintext -$ glab mr diff 123 -$ glab mr diff branch -$ glab mr diff # get from current branch -$ glab mr diff 123 --color=never +glab mr diff 123 +glab mr diff branch +glab mr diff # get from current branch +glab mr diff 123 --color=never ``` -### Options +## Options ```plaintext --color string Use color in diff output: {always|never|auto} (default "auto") ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/for.md b/docs/source/mr/for.md index b097ff7b..1664ad6e 100644 --- a/docs/source/mr/for.md +++ b/docs/source/mr/for.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr for +# `glab mr for` Create new merge request for an issue @@ -20,14 +20,14 @@ glab mr for [flags] ## Examples ```plaintext -$ glab mr for 34 # Create mr for issue 34 -$ glab mr for 34 --wip # Create mr and mark as work in progress -$ glab mr new-for 34 -$ glab mr create-for 34 +glab mr for 34 # Create mr for issue 34 +glab mr for 34 --wip # Create mr and mark as work in progress +glab mr new-for 34 +glab mr create-for 34 ``` -### Options +## Options ```plaintext --allow-collaboration Allow commits from other members @@ -41,10 +41,9 @@ $ glab mr create-for 34 --with-labels Copy labels from issue to the merge request ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/help.md b/docs/source/mr/help.md index f7e52dab..813db979 100644 --- a/docs/source/mr/help.md +++ b/docs/source/mr/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr help +# `glab mr help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type mr help [path to command] for full details. - ```plaintext glab mr help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/index.md b/docs/source/mr/index.md index 6f120a17..28ba514f 100755 --- a/docs/source/mr/index.md +++ b/docs/source/mr/index.md @@ -9,26 +9,26 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr +# `glab mr` Create, view and manage merge requests ## Examples ```plaintext -$ glab mr create --fill --label bugfix -$ glab mr merge 123 -$ glab mr note -m "needs to do X before it can be merged" branch-foo +glab mr create --fill --label bugfix +glab mr merge 123 +glab mr note -m "needs to do X before it can be merged" branch-foo ``` -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -56,4 +56,3 @@ $ glab mr note -m "needs to do X before it can be merged" branch-foo - [unsubscribe](unsubscribe.md) - [update](update.md) - [view](view.md) - diff --git a/docs/source/mr/issues.md b/docs/source/mr/issues.md index 2ca57d85..a2a3a04a 100644 --- a/docs/source/mr/issues.md +++ b/docs/source/mr/issues.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr issues +# `glab mr issues` Get issues related to a particular merge request. @@ -20,16 +20,15 @@ glab mr issues [ | ] [flags] ## Examples ```plaintext -$ glab mr issues 46 -$ glab mr issues branch -$ glab mr issues # use checked out branch +glab mr issues 46 +glab mr issues branch +glab mr issues # use checked out branch ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/list.md b/docs/source/mr/list.md index 97933c5f..34c8b91d 100644 --- a/docs/source/mr/list.md +++ b/docs/source/mr/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr list +# `glab mr list` List merge requests @@ -20,20 +20,20 @@ glab mr list [flags] ## Examples ```plaintext -$ glab mr list --all -$ glab mr ls -a -$ glab mr list --assignee=@me -$ glab mr list --reviewer=@me -$ glab mr list --source-branch=new-feature -$ glab mr list --target-branch=main -$ glab mr list --search "this adds feature X" -$ glab mr list --label needs-review -$ glab mr list --not-label waiting-maintainer-feedback,subsystem-x -$ glab mr list -M --per-page 10 +glab mr list --all +glab mr ls -a +glab mr list --assignee=@me +glab mr list --reviewer=@me +glab mr list --source-branch=new-feature +glab mr list --target-branch=main +glab mr list --search "this adds feature X" +glab mr list --label needs-review +glab mr list --not-label waiting-maintainer-feedback,subsystem-x +glab mr list -M --per-page 10 ``` -### Options +## Options ```plaintext -A, --all Get all merge requests @@ -54,10 +54,9 @@ $ glab mr list -M --per-page 10 -t, --target-branch string Filter by target branch ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/merge.md b/docs/source/mr/merge.md index a3677ebc..26023013 100644 --- a/docs/source/mr/merge.md +++ b/docs/source/mr/merge.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr merge +# `glab mr merge` Merge/Accept merge requests @@ -20,13 +20,13 @@ glab mr merge { | } [flags] ## Examples ```plaintext -$ glab mr merge 235 -$ glab mr accept 235 -$ glab mr merge # Finds open merge request from current branch +glab mr merge 235 +glab mr accept 235 +glab mr merge # Finds open merge request from current branch ``` -### Options +## Options ```plaintext -m, --message string Custom merge commit message @@ -39,10 +39,9 @@ $ glab mr merge # Finds open merge request from current branch -y, --yes Skip submission confirmation prompt ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/note.md b/docs/source/mr/note.md index 07630e10..a5d74b7e 100644 --- a/docs/source/mr/note.md +++ b/docs/source/mr/note.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr note +# `glab mr note` Add a comment or note to merge request @@ -17,16 +17,15 @@ Add a comment or note to merge request glab mr note [ | ] [flags] ``` -### Options +## Options ```plaintext -m, --message string Comment/Note message ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/rebase.md b/docs/source/mr/rebase.md index 65b6254f..2fe8cef5 100644 --- a/docs/source/mr/rebase.md +++ b/docs/source/mr/rebase.md @@ -9,13 +9,13 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr rebase +# `glab mr rebase` Automatically rebase the source_branch of the merge request against its target_branch. ## Synopsis -If you don’t have permissions to push to the merge request’s source branch - you’ll get a 403 Forbidden response. +If you don't have permissions to push to the merge request's source branch - you'll get a 403 Forbidden response. ```plaintext glab mr rebase [ | ] [flags] @@ -24,16 +24,15 @@ glab mr rebase [ | ] [flags] ## Examples ```plaintext -$ glab mr rebase 123 -$ glab mr rebase # get from current branch -$ glab mr rebase branch +glab mr rebase 123 +glab mr rebase # get from current branch +glab mr rebase branch ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/reopen.md b/docs/source/mr/reopen.md index de366b16..29b1b509 100644 --- a/docs/source/mr/reopen.md +++ b/docs/source/mr/reopen.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr reopen +# `glab mr reopen` Reopen merge requests @@ -20,17 +20,16 @@ glab mr reopen [... | ...] [flags] ## Examples ```plaintext -$ glab mr reopen 123 -$ glab mr reopen 123 456 789 -$ glab mr reopen branch-1 branch-2 -$ glab mr reopen # use checked out branch +glab mr reopen 123 +glab mr reopen 123 456 789 +glab mr reopen branch-1 branch-2 +glab mr reopen # use checked out branch ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/revoke.md b/docs/source/mr/revoke.md index dd9cc5fd..c021a89d 100644 --- a/docs/source/mr/revoke.md +++ b/docs/source/mr/revoke.md @@ -9,9 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr revoke +# `glab mr revoke` -Revoke approval on a merge request +Revoke approval on a merge request ```plaintext glab mr revoke [ | ] [flags] @@ -20,18 +20,17 @@ glab mr revoke [ | ] [flags] ## Examples ```plaintext -$ glab mr revoke 123 -$ glab mr unapprove 123 -$ glab mr revoke branch -$ glab mr revoke # use checked out branch -$ glab mr revoke 123 branch 456 +glab mr revoke 123 +glab mr unapprove 123 +glab mr revoke branch +glab mr revoke # use checked out branch +glab mr revoke 123 branch 456 ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/subscribe.md b/docs/source/mr/subscribe.md index 9607d190..4df24d43 100644 --- a/docs/source/mr/subscribe.md +++ b/docs/source/mr/subscribe.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr subscribe +# `glab mr subscribe` Subscribe to merge requests @@ -20,17 +20,16 @@ glab mr subscribe [ | ] [flags] ## Examples ```plaintext -$ glab mr subscribe 123 -$ glab mr sub 123 -$ glab mr subscribe branch -$ glab mr subscribe 123 branch # subscribe to multiple MRs +glab mr subscribe 123 +glab mr sub 123 +glab mr subscribe branch +glab mr subscribe 123 branch # subscribe to multiple MRs ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/todo.md b/docs/source/mr/todo.md index 8f73f6d5..e9bc0de5 100644 --- a/docs/source/mr/todo.md +++ b/docs/source/mr/todo.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr todo +# `glab mr todo` Add a ToDo to merge request @@ -17,10 +17,9 @@ Add a ToDo to merge request glab mr todo [ | ] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/unsubscribe.md b/docs/source/mr/unsubscribe.md index d706f008..2ea4d726 100644 --- a/docs/source/mr/unsubscribe.md +++ b/docs/source/mr/unsubscribe.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr unsubscribe +# `glab mr unsubscribe` Unsubscribe from merge requests @@ -20,17 +20,16 @@ glab mr unsubscribe [ | ] [flags] ## Examples ```plaintext -$ glab mr unsubscribe 123 -$ glab mr unsub 123 -$ glab mr unsubscribe branch -$ glab mr unsubscribe 123 branch # unsubscribe from multiple MRs +glab mr unsubscribe 123 +glab mr unsub 123 +glab mr unsubscribe branch +glab mr unsubscribe 123 branch # unsubscribe from multiple MRs ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/update.md b/docs/source/mr/update.md index 5b54bca6..4ec85e28 100644 --- a/docs/source/mr/update.md +++ b/docs/source/mr/update.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr update +# `glab mr update` Update merge requests @@ -20,13 +20,13 @@ glab mr update [ | ] [flags] ## Examples ```plaintext -$ glab mr update 23 --ready -$ glab mr update 23 --draft -$ glab mr update --draft # Updates MR related to current branch +glab mr update 23 --ready +glab mr update 23 --draft +glab mr update --draft # Updates MR related to current branch ``` -### Options +## Options ```plaintext -a, --assignee strings assign users via username, prefix with '!' or '-' to remove from existing assignees, '+' to add, otherwise replace existing assignees with given users @@ -47,10 +47,9 @@ $ glab mr update --draft # Updates MR related to current branch --wip Mark merge request as a work in progress. Alternative to --draft ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/mr/view.md b/docs/source/mr/view.md index e456daec..1e21defb 100644 --- a/docs/source/mr/view.md +++ b/docs/source/mr/view.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab mr view +# `glab mr view` Display the title, body, and other information about a merge request. @@ -17,7 +17,7 @@ Display the title, body, and other information about a merge request. glab mr view { | } [flags] ``` -### Options +## Options ```plaintext -c, --comments Show mr comments and activities @@ -27,10 +27,9 @@ glab mr view { | } [flags] -w, --web Open mr in a browser. Uses default browser or browser specified in BROWSER variable ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/release/create.md b/docs/source/release/create.md index 692a0ed8..f2c482c0 100644 --- a/docs/source/release/create.md +++ b/docs/source/release/create.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release create +# `glab release create` Create a new or update a GitLab Release for a repository @@ -19,17 +19,16 @@ Create a new or update a GitLab Release for a repository. If the release already exists, glab updates the release with the new info provided. -If a git tag specified does not yet exist, the release will automatically get created +If a Git tag specified does not yet exist, the release will automatically get created from the latest state of the default branch and tagged with the specified tag name. Use `--ref` to override this. The `ref` can be a commit SHA, another tag name, or a branch name. To fetch the new tag locally after the release, do `git fetch --tags origin`. -To create a release from an annotated git tag, first create one locally with -git, push the tag to GitLab, then run this command. - -NB: Developer level access to the project is required to create a release. +To create a release from an annotated Git tag, first create one locally with +Git, push the tag to GitLab, then run this command. +Developer level access to the project is required to create a release. ```plaintext glab release create [...] [flags] @@ -61,18 +60,18 @@ $ glab release create v1.0.1 ./dist/*.tar.gz Create a release with assets specified as JSON object $ glab release create v1.0.1 --assets-links=' - [ - { - "name": "Asset1", - "url":"https:///some/location/1", - "link_type": "other", - "filepath": "path/to/file" - } - ]' + [ + { + "name": "Asset1", + "url":"https:///some/location/1", + "link_type": "other", + "filepath": "path/to/file" + } + ]' ``` -### Options +## Options ```plaintext -a, --assets-links JSON JSON string representation of assets links (e.g. `--assets='[{"name": "Asset1", "url":"https:///some/location/1", "link_type": "other", "filepath": "path/to/file"}]')` @@ -84,10 +83,9 @@ $ glab release create v1.0.1 --assets-links=' -D, --released-at date The date when the release is/was ready. Defaults to the current datetime. Expected in ISO 8601 format (2019-03-15T08:00:00Z) ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/release/delete.md b/docs/source/release/delete.md index 14ce4318..d519e12e 100644 --- a/docs/source/release/delete.md +++ b/docs/source/release/delete.md @@ -9,9 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release delete +# `glab release delete` -Delete a GitLab Release +Delete a GitLab Release ## Synopsis @@ -20,7 +20,6 @@ Delete release assets to GitLab Release Deleting a release does not delete the associated tag unless `--with-tag` is specified. Maintainer level access to the project is required to delete a release. - ```plaintext glab release delete [flags] ``` @@ -39,17 +38,16 @@ $ glab release delete v1.0.1 --with-tag ``` -### Options +## Options ```plaintext -t, --with-tag Delete associated tag -y, --yes Skip confirmation prompt ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/release/download.md b/docs/source/release/download.md index 8fa3f376..e96a6a42 100644 --- a/docs/source/release/download.md +++ b/docs/source/release/download.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release download +# `glab release download` Download asset files from a GitLab Release @@ -23,7 +23,6 @@ Use `--asset-name` to specify a file name to download from the release assets. Unless `--include-external` flag is specified, external files are not downloaded. - ```plaintext glab release download [flags] ``` @@ -42,7 +41,7 @@ $ glab release download v1.10.1 --asset-name="*.tar.gz" ``` -### Options +## Options ```plaintext -n, --asset-name stringArray Download only assets that match the name or a glob pattern @@ -50,10 +49,9 @@ $ glab release download v1.10.1 --asset-name="*.tar.gz" -x, --include-external Include external asset files ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/release/help.md b/docs/source/release/help.md index 985e6629..a44f7af4 100644 --- a/docs/source/release/help.md +++ b/docs/source/release/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release help +# `glab release help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type release help [path to command] for full details. - ```plaintext glab release help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/release/index.md b/docs/source/release/index.md index 50df6c89..ce951334 100755 --- a/docs/source/release/index.md +++ b/docs/source/release/index.md @@ -9,17 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release +# `glab release` Manage GitLab releases -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -33,4 +33,3 @@ Manage GitLab releases - [list](list.md) - [upload](upload.md) - [view](view.md) - diff --git a/docs/source/release/list.md b/docs/source/release/list.md index 95a58ad1..546439d1 100644 --- a/docs/source/release/list.md +++ b/docs/source/release/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release list +# `glab release list` List releases in a repository @@ -17,10 +17,9 @@ List releases in a repository glab release list [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/release/upload.md b/docs/source/release/upload.md index 893f9ce5..6bdb51f4 100644 --- a/docs/source/release/upload.md +++ b/docs/source/release/upload.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release upload +# `glab release upload` Upload release asset files or links to GitLab Release @@ -20,7 +20,6 @@ Upload release assets to GitLab Release You can define the display name by appending '#' after the file name. The link type comes after the display name (eg. 'myfile.tar.gz#My display name#package') - ```plaintext glab release upload [...] [flags] ``` @@ -42,27 +41,26 @@ $ glab release upload v1.0.1 ./dist/*.tar.gz Upload release assets links specified as JSON string $ glab release upload v1.0.1 --assets-links=' - [ - { - "name": "Asset1", - "url":"https:///some/location/1", - "link_type": "other", - "filepath": "path/to/file" - } - ]' + [ + { + "name": "Asset1", + "url":"https:///some/location/1", + "link_type": "other", + "filepath": "path/to/file" + } + ]' ``` -### Options +## Options ```plaintext -a, --assets-links JSON JSON string representation of assets links (e.g. `--assets='[{"name": "Asset1", "url":"https:///some/location/1", "link_type": "other", "filepath": "path/to/file"}]')` ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/release/view.md b/docs/source/release/view.md index 4d968af0..4cd5f5bc 100644 --- a/docs/source/release/view.md +++ b/docs/source/release/view.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab release view +# `glab release view` View information about a GitLab Release @@ -18,7 +18,6 @@ View information about a GitLab Release View information about a GitLab Release. Without an explicit tag name argument, the latest release in the project is shown. -%!(EXTRA string=`) ```plaintext glab release view [flags] @@ -35,16 +34,15 @@ $ glab release view v1.0.1 ``` -### Options +## Options ```plaintext -w, --web Open the release in the browser ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/repo/archive.md b/docs/source/repo/archive.md index 3dc2b6ec..7eb67fd5 100644 --- a/docs/source/repo/archive.md +++ b/docs/source/repo/archive.md @@ -9,18 +9,18 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo archive +# `glab repo archive` Get an archive of the repository. ## Synopsis Clone supports these shorthands + - repo - namespace/repo - namespace/group/repo - ```plaintext glab repo archive [flags] ``` @@ -28,23 +28,22 @@ glab repo archive [flags] ## Examples ```plaintext -$ glab repo archive profclems/glab -$ glab repo archive # Downloads zip file of current repository -$ glab repo archive profclems/glab mydirectory # Downloads repo zip file into mydirectory -$ glab repo archive profclems/glab --format=zip # Finds repo for current user and download in zip format +glab repo archive profclems/glab +glab repo archive # Downloads zip file of current repository +glab repo archive profclems/glab mydirectory # Downloads repo zip file into mydirectory +glab repo archive profclems/glab --format=zip # Finds repo for current user and download in zip format ``` -### Options +## Options ```plaintext -f, --format string Optionally Specify format if you want a downloaded archive: {tar.gz|tar.bz2|tbz|tbz2|tb2|bz2|tar|zip} (Default: zip) (default "zip") -s, --sha string The commit SHA to download. A tag, branch reference, or SHA can be used. This defaults to the tip of the default branch if not specified ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/clone.md b/docs/source/repo/clone.md index c8412667..2940213b 100644 --- a/docs/source/repo/clone.md +++ b/docs/source/repo/clone.md @@ -9,20 +9,18 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo clone - -Clone a Gitlab repository/project - -## Synopsis +# `glab repo clone` Clone a GitLab repository/project - Clone supports these shorthands - - repo - - namespace/repo - - org/group/repo - - project ID - +## Synopsis + +Clone supports these shorthands + +- repo +- namespace/repo +- org/group/repo +- project ID ```plaintext glab repo clone [] [-- [...]] [flags] @@ -49,7 +47,7 @@ $ GITLAB_HOST=salsa.debian.org glab repo clone myrepo ``` -### Options +## Options ```plaintext -g, --group string Specify group to clone repositories from @@ -66,9 +64,8 @@ $ GITLAB_HOST=salsa.debian.org glab repo clone myrepo --per-page int Number of items to list per page (default 30) ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/contributors.md b/docs/source/repo/contributors.md index b886b0ab..94b8db59 100644 --- a/docs/source/repo/contributors.md +++ b/docs/source/repo/contributors.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo contributors +# `glab repo contributors` Get repository contributors list. @@ -27,7 +27,7 @@ $ glab repo contributors -R gitlab-com/www-gitlab-com ``` -### Options +## Options ```plaintext -o, --order string Return contributors ordered by name, email, or commits (orders by commit date) fields (default "commits") @@ -37,9 +37,8 @@ $ glab repo contributors -R gitlab-com/www-gitlab-com -s, --sort string Return contributors sorted in asc or desc order ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/create.md b/docs/source/repo/create.md index 96b18c80..24010a33 100644 --- a/docs/source/repo/create.md +++ b/docs/source/repo/create.md @@ -9,13 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo create +# `glab repo create` -Create a new GitLab project/repository - -## Synopsis - -Create a new GitLab repository. +Create a new GitLab project/repository. ```plaintext glab repo create [path] [flags] @@ -38,7 +34,7 @@ $ glab repo create glab-cli/my-project ``` -### Options +## Options ```plaintext --defaultBranch master Default branch of the project. If not provided, master by default. @@ -53,9 +49,8 @@ $ glab repo create glab-cli/my-project -t, --tag stringArray The list of tags for the project. ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/delete.md b/docs/source/repo/delete.md index 8d97bde8..bc1da580 100644 --- a/docs/source/repo/delete.md +++ b/docs/source/repo/delete.md @@ -9,13 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo delete +# `glab repo delete` -Delete an existing repository on GitLab - -## Synopsis - -Delete an existing repository on GitLab +Delete an existing repository on GitLab. ```plaintext glab repo delete [/] [flags] @@ -34,15 +30,14 @@ $ glab repo delete myorg/mynamespace/dotfiles ``` -### Options +## Options ```plaintext -y, --yes Skip the confirmation prompt and immediately delete the repository. ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/fork.md b/docs/source/repo/fork.md index cc499e46..c3f4e64e 100644 --- a/docs/source/repo/fork.md +++ b/docs/source/repo/fork.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo fork +# `glab repo fork` Create a fork of a GitLab repository @@ -20,13 +20,13 @@ glab repo fork [flags] ## Examples ```plaintext -$ glab repo fork -$ glab repo fork namespace/repo -$ glab repo fork namespace/repo --clone +glab repo fork +glab repo fork namespace/repo +glab repo fork namespace/repo --clone ``` -### Options +## Options ```plaintext -c, --clone Clone the fork {true|false} @@ -35,9 +35,8 @@ $ glab repo fork namespace/repo --clone --remote Add remote for fork {true|false} ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/help.md b/docs/source/repo/help.md index 1d63a318..86562acd 100644 --- a/docs/source/repo/help.md +++ b/docs/source/repo/help.md @@ -9,22 +9,16 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo help +# `glab repo help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type repo help [path to command] for full details. - ```plaintext glab repo help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/index.md b/docs/source/repo/index.md index 4cb25d7c..f65de95c 100755 --- a/docs/source/repo/index.md +++ b/docs/source/repo/index.md @@ -9,11 +9,11 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo +# `glab repo` Work with GitLab repositories and projects -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -32,4 +32,3 @@ Work with GitLab repositories and projects - [search](search.md) - [transfer](transfer.md) - [view](view.md) - diff --git a/docs/source/repo/list.md b/docs/source/repo/list.md index 6e72f427..2dc307cf 100644 --- a/docs/source/repo/list.md +++ b/docs/source/repo/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo list +# `glab repo list` Get list of repositories. @@ -20,11 +20,11 @@ glab repo list [flags] ## Examples ```plaintext -$ glab repo list +glab repo list ``` -### Options +## Options ```plaintext -a, --all List all projects on the instance @@ -38,9 +38,8 @@ $ glab repo list --starred Only list starred projects ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/mirror.md b/docs/source/repo/mirror.md index 6cfba6d6..71e26751 100644 --- a/docs/source/repo/mirror.md +++ b/docs/source/repo/mirror.md @@ -9,19 +9,15 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo mirror +# `glab repo mirror` -Mirror a project/repository - -## Synopsis - -Mirrors a project/repository to the specified location using pull or push method. +Mirror a project/repository to the specified location using pull or push method. ```plaintext glab repo mirror [ID | URL | PATH] [flags] ``` -### Options +## Options ```plaintext --allow-divergence Determines if divergent refs are skipped. @@ -31,9 +27,8 @@ glab repo mirror [ID | URL | PATH] [flags] --url string The target URL to which the repository is mirrored. ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/search.md b/docs/source/repo/search.md index d1f5085d..9ff1de9a 100644 --- a/docs/source/repo/search.md +++ b/docs/source/repo/search.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo search +# `glab repo search` Search for GitLab repositories and projects by name @@ -20,14 +20,14 @@ glab repo search [flags] ## Examples ```plaintext -$ glab project search title -$ glab repo search title -$ glab project find title -$ glab project lookup title +glab project search title +glab repo search title +glab project find title +glab project lookup title ``` -### Options +## Options ```plaintext -p, --page int Page number (default 1) @@ -35,9 +35,8 @@ $ glab project lookup title -s, --search string A string contained in the project name ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/transfer.md b/docs/source/repo/transfer.md index 50a36244..984a92dc 100644 --- a/docs/source/repo/transfer.md +++ b/docs/source/repo/transfer.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo transfer +# `glab repo transfer` Transfer a repository to a new namespace. @@ -20,20 +20,19 @@ glab repo transfer [repo] [flags] ## Examples ```plaintext -$ glab repo transfer profclems/glab --target-namespace notprofclems +glab repo transfer profclems/glab --target-namespace notprofclems ``` -### Options +## Options ```plaintext -t, --target-namespace string The namespace where your project should be transferred to -y, --yes Danger: Skip confirmation prompt and force transfer operation. Transfer cannot be undone. ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/repo/view.md b/docs/source/repo/view.md index ce07fcac..661693a6 100644 --- a/docs/source/repo/view.md +++ b/docs/source/repo/view.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab repo view +# `glab repo view` View a project/repository @@ -39,16 +39,15 @@ $ glab repo view https://gitlab.company.org/user/repo.git ``` -### Options +## Options ```plaintext -b, --branch string View a specific branch of the repository -w, --web Open a project in the browser ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/snippet/create.md b/docs/source/snippet/create.md index a377496d..defc2191 100644 --- a/docs/source/snippet/create.md +++ b/docs/source/snippet/create.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab snippet create +# `glab snippet create` Create new snippet @@ -20,13 +20,13 @@ glab snippet create [path] [flags] ## Examples ```plaintext -$ glab snippet create script.py --title "Title of the snippet" -$ echo "package main" | glab snippet new --title "Title of the snippet" --filename "main.go" -$ glab snippet create main.go -t Title -f "different.go" -d Description +glab snippet create script.py --title "Title of the snippet" +echo "package main" | glab snippet new --title "Title of the snippet" --filename "main.go" +glab snippet create main.go -t Title -f "different.go" -d Description ``` -### Options +## Options ```plaintext -d, --description string Description of the snippet @@ -35,10 +35,9 @@ $ glab snippet create main.go -t Title -f "different.go" -d Description -v, --visibility string Limit by visibility {public, internal, or private} (default "private") ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/snippet/help.md b/docs/source/snippet/help.md index 74a4c6d1..11385289 100644 --- a/docs/source/snippet/help.md +++ b/docs/source/snippet/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab snippet help +# `glab snippet help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type snippet help [path to command] for full details. - ```plaintext glab snippet help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/snippet/index.md b/docs/source/snippet/index.md index 207d7d97..215f4693 100755 --- a/docs/source/snippet/index.md +++ b/docs/source/snippet/index.md @@ -9,24 +9,24 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab snippet +# `glab snippet` Create, view and manage snippets ## Examples ```plaintext -$ glab snippet create --title "Title of the snippet" --filename "main.go" +glab snippet create --title "Title of the snippet" --filename "main.go" ``` -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -35,4 +35,3 @@ $ glab snippet create --title "Title of the snippet" --filename "main.go" ## Subcommands - [create](create.md) - diff --git a/docs/source/ssh-key/add.md b/docs/source/ssh-key/add.md index d1ea13ad..b3ea0e3e 100644 --- a/docs/source/ssh-key/add.md +++ b/docs/source/ssh-key/add.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ssh-key add +# `glab ssh-key add` Add an SSH key to your GitLab account @@ -19,7 +19,6 @@ Creates a new SSH key owned by the currently authenticated user. The --title flag is always required - ```plaintext glab ssh-key add [key-file] [flags] ``` @@ -35,17 +34,16 @@ $ glab ssh-key add ~/.ssh/id_ed25519.pub -t "my title" ``` -### Options +## Options ```plaintext -e, --expires-at string The expiration date of the SSH key in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ) -t, --title string New SSH key's title ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/ssh-key/get.md b/docs/source/ssh-key/get.md index 70baf34a..1e177938 100644 --- a/docs/source/ssh-key/get.md +++ b/docs/source/ssh-key/get.md @@ -9,13 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ssh-key get +# `glab ssh-key get` -Gets a single key - -## Synopsis - -Returns a single SSH key specified by the ID +Returns a single SSH key specified by the ID. ```plaintext glab ssh-key get [flags] @@ -32,10 +28,9 @@ $ glab ssh-key get ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/ssh-key/help.md b/docs/source/ssh-key/help.md index ba79c4a3..feb4717e 100644 --- a/docs/source/ssh-key/help.md +++ b/docs/source/ssh-key/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ssh-key help +# `glab ssh-key help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type ssh-key help [path to command] for full details. - ```plaintext glab ssh-key help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/ssh-key/index.md b/docs/source/ssh-key/index.md index 86615f82..41c9fd41 100755 --- a/docs/source/ssh-key/index.md +++ b/docs/source/ssh-key/index.md @@ -9,21 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ssh-key +# `glab ssh-key` -Manage SSH keys +Manage SSH keys registered with your GitLab account. -## Synopsis - -Manage SSH keys registered with your GitLab account - -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -34,4 +30,3 @@ Manage SSH keys registered with your GitLab account - [add](add.md) - [get](get.md) - [list](list.md) - diff --git a/docs/source/ssh-key/list.md b/docs/source/ssh-key/list.md index 10404f47..ad751f2a 100644 --- a/docs/source/ssh-key/list.md +++ b/docs/source/ssh-key/list.md @@ -9,13 +9,9 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab ssh-key list +# `glab ssh-key list` -Lists currently authenticated user’s SSH keys - -## Synopsis - -Get a list of currently authenticated user’s SSH keys +Get a list of currently authenticated user's SSH keys. ```plaintext glab ssh-key list [flags] @@ -24,20 +20,19 @@ glab ssh-key list [flags] ## Examples ```plaintext -$ glab ssh-key list +glab ssh-key list ``` -### Options +## Options ```plaintext --show-id Show IDs of SSH Keys ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/user/events.md b/docs/source/user/events.md index 7dd72f62..f5813f6f 100644 --- a/docs/source/user/events.md +++ b/docs/source/user/events.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab user events +# `glab user events` View user events @@ -17,15 +17,14 @@ View user events glab user events [flags] ``` -### Options +## Options ```plaintext -a, --all Get events from all projects ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/user/help.md b/docs/source/user/help.md index b26c4b33..9f9fc847 100644 --- a/docs/source/user/help.md +++ b/docs/source/user/help.md @@ -9,22 +9,16 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab user help +# `glab user help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type user help [path to command] for full details. - ```plaintext glab user help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` - diff --git a/docs/source/user/index.md b/docs/source/user/index.md index 0e40410a..c6b898bb 100755 --- a/docs/source/user/index.md +++ b/docs/source/user/index.md @@ -9,11 +9,11 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab user +# `glab user` Interact with user -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -22,4 +22,3 @@ Interact with user ## Subcommands - [events](events.md) - diff --git a/docs/source/variable/delete.md b/docs/source/variable/delete.md index 79125255..98b277e3 100644 --- a/docs/source/variable/delete.md +++ b/docs/source/variable/delete.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab variable delete +# `glab variable delete` Delete a project or group variable @@ -20,23 +20,22 @@ glab variable delete [flags] ## Examples ```plaintext -$ glab variable delete VAR_NAME -$ glab variable delete VAR_NAME --scope=prod -$ glab variable delete VARNAME -g mygroup +glab variable delete VAR_NAME +glab variable delete VAR_NAME --scope=prod +glab variable delete VARNAME -g mygroup ``` -### Options +## Options ```plaintext -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 +## Options inherited from parent commands ```plaintext --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/get.md b/docs/source/variable/get.md index 27be1601..17bd0114 100644 --- a/docs/source/variable/get.md +++ b/docs/source/variable/get.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab variable get +# `glab variable get` get a project or group variable @@ -20,21 +20,20 @@ glab variable get [flags] ## Examples ```plaintext -$ glab variable get VAR_KEY - $ glab variable get -g GROUP VAR_KEY +glab variable get VAR_KEY + glab variable get -g GROUP VAR_KEY ``` -### Options +## Options ```plaintext -g, --group string Get variable for a group ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/help.md b/docs/source/variable/help.md index a5ec8791..04c6c38d 100644 --- a/docs/source/variable/help.md +++ b/docs/source/variable/help.md @@ -9,23 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab variable help +# `glab variable help` Help about any command -## Synopsis - -Help provides help for any command in the application. -Simply type variable help [path to command] for full details. - ```plaintext glab variable help [command] [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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.md b/docs/source/variable/index.md index fefd737a..e42a6392 100755 --- a/docs/source/variable/index.md +++ b/docs/source/variable/index.md @@ -9,17 +9,17 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab variable +# `glab variable` Manage GitLab Project and Group Variables -### Options +## Options ```plaintext -R, --repo OWNER/REPO Select another repository using the OWNER/REPO or `GROUP/NAMESPACE/REPO` format or full URL or git URL ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command @@ -32,4 +32,3 @@ Manage GitLab Project and Group Variables - [list](list.md) - [set](set.md) - [update](update.md) - diff --git a/docs/source/variable/list.md b/docs/source/variable/list.md index b2b64bc5..aabdc37d 100644 --- a/docs/source/variable/list.md +++ b/docs/source/variable/list.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab variable list +# `glab variable list` List project or group variables @@ -20,20 +20,19 @@ glab variable list [flags] ## Examples ```plaintext -$ glab variable list +glab variable list ``` -### Options +## Options ```plaintext -g, --group string List group variables ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/set.md b/docs/source/variable/set.md index 9f6b6d01..16d2ea1b 100644 --- a/docs/source/variable/set.md +++ b/docs/source/variable/set.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab variable set +# `glab variable set` Create a new project or group variable @@ -20,17 +20,17 @@ glab variable set [flags] ## Examples ```plaintext -$ glab variable set WITH_ARG "some value" -$ glab variable set FROM_FLAG -v "some value" -$ glab variable set FROM_ENV_WITH_ARG "${ENV_VAR}" -$ glab variable set FROM_ENV_WITH_FLAG -v"${ENV_VAR}" -$ glab variable set FROM_FILE < secret.txt -$ cat file.txt | glab variable set SERVER_TOKEN -$ cat token.txt | glab variable set GROUP_TOKEN -g mygroup --scope=prod +glab variable set WITH_ARG "some value" +glab variable set FROM_FLAG -v "some value" +glab variable set FROM_ENV_WITH_ARG "${ENV_VAR}" +glab variable set FROM_ENV_WITH_FLAG -v"${ENV_VAR}" +glab variable set FROM_FILE < secret.txt +cat file.txt | glab variable set SERVER_TOKEN +cat token.txt | glab variable set GROUP_TOKEN -g mygroup --scope=prod ``` -### Options +## Options ```plaintext -g, --group string Set variable for a group @@ -41,10 +41,9 @@ $ cat token.txt | glab variable set GROUP_TOKEN -g mygroup --scope=prod -v, --value string The value of a variable ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/update.md b/docs/source/variable/update.md index a1222890..64aa589a 100644 --- a/docs/source/variable/update.md +++ b/docs/source/variable/update.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab variable update +# `glab variable update` Update an existing project or group variable @@ -20,17 +20,17 @@ glab variable update [flags] ## Examples ```plaintext -$ 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 +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 +## Options ```plaintext -g, --group string Set variable for a group @@ -41,10 +41,9 @@ $ cat token.txt | glab variable update GROUP_TOKEN -g mygroup --scope=prod -v, --value string The value of a variable ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --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/version/index.md b/docs/source/version/index.md index 0bb03114..9c8b1085 100755 --- a/docs/source/version/index.md +++ b/docs/source/version/index.md @@ -9,7 +9,7 @@ This documentation is auto generated by a script. Please do not edit this file directly, check cmd/gen-docs/docs.go. --> -# glab version +# `glab version` Show glab version information @@ -17,9 +17,8 @@ Show glab version information glab version [flags] ``` -### Options inherited from parent commands +## Options inherited from parent commands ```plaintext --help Show help for command ``` -