STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
load test
5130 commits 87 branches 0 tags 160 MiB
Find a file
Mislav Marohnić 3c443efbed Improve Survey prompt stubber for tests 
Both SurveyAsk and SurveyAskOne methods now share the same sets of
stubs, making it possible to change which of these methods is used in
the implementation without breaking tests.

A new method `AskStubber.StubPrompt("<prompt>")` is added as test helper
to supersede old Stub and StubOne methods. The new helper matches on
prompt messages rather than on field names, enabling tests to be written
based on what the user would see rather than coupling to implementation
details.

The new stubber also allows verifying whether a Select or MultiSelect
was rendered with the expected set of options. Furthermore, if a stubbed
value is not present among those options, the stubber will panic instead
of continuing normally.

Stubbed Selects with an int instead of a string target receiver are now
transparently handled. The values for Select stubs are always strings in
tests, but the stubber will write an int answer if the receiver expects
one as a selected index instead of a selected string value.

Lastly, this set of changes improves test resiliency since the stubs are
now matched based on prompt message (or field name for legacy stubs
created with Stub) instead of sequentially, enabling the implementation
to reorder the prompts without breaking existing tests.
2022-01-12 23:51:21 +01:00
.github oops 2021-11-24 16:45:27 -06:00
.vscode Add VS Code settings 2019-10-07 16:36:23 +02:00
api #4386 Display a user's name in metadata survey for assignees and reviewers (#4420) 2022-01-12 08:52:22 +00:00
cmd Refresh man pages 2021-12-20 18:11:31 +01:00
context Rename the module to "github.com/cli/cli/v2" 2021-08-25 12:41:30 +02:00
docs Add installation instructions for NetBSD/pkgsrc (#4931) 2021-12-20 10:00:57 +00:00
git Unconditionally resolve "ssh.github.com" to "github.com" 2021-12-20 16:09:46 +01:00
internal Tweak auth flow re: interactivity 2022-01-12 15:50:51 +01:00
pkg Improve Survey prompt stubber for tests 2022-01-12 23:51:21 +01:00
script Generate release notes using the new API 2021-10-14 20:22:38 +02:00
test Pass web browser to each individual command 2021-03-19 21:22:37 +01:00
utils Rename the module to "github.com/cli/cli/v2" 2021-08-25 12:41:30 +02:00
.gitattributes Retire copy-release-to-another-repo action 2020-01-29 16:13:07 +01:00
.gitignore Port select portions of Makefile to script/build.go 2021-01-08 22:35:57 +01:00
.golangci.yml Prevent further use of SetPrepareCmd and InitCmdStubber 2021-01-18 22:44:53 +01:00
.goreleaser.yml Refresh man pages 2021-12-20 18:11:31 +01:00
CODEOWNERS Fix CODEOWNERS for codespaces 2021-11-15 20:05:54 +01:00
go.mod Improve setting multiple secrets 2021-12-20 23:35:31 +01:00
go.sum Improve setting multiple secrets 2021-12-20 23:35:31 +01:00
LICENSE Create LICENSE 2019-11-21 13:22:23 -06:00
Makefile Tweak build scripts to enable cross-compiling 2021-04-09 15:48:12 +02:00
README.md Update winget installation instructions 2021-10-13 15:01:50 +01:00
wix.json Rename "master" to "trunk" in various links 2020-05-26 20:57:26 +02:00

README.md

GitHub CLI

gh is GitHub on the command line. It brings pull requests, issues, and other GitHub concepts to the terminal next to where you are already working with git and your code.

screenshot of gh pr status

GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterprise Server 2.20+, and to install on macOS, Windows, and Linux.

Documentation

See the manual for setup and usage instructions.

Contributing

If anything feels off, or if you feel that some functionality is missing, please check out the contributing page. There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project.

Installation

macOS

gh is available via Homebrew, MacPorts, Conda, Spack, and as a downloadable binary from the releases page.

Homebrew

Install: Upgrade:
brew install gh brew upgrade gh

MacPorts

Install: Upgrade:
sudo port install gh sudo port selfupdate && sudo port upgrade gh

Conda

Install: Upgrade:
conda install gh --channel conda-forge conda update gh --channel conda-forge

Additional Conda installation options available on the gh-feedstock page.

Spack

Install: Upgrade:
spack install gh spack uninstall gh && spack install gh

Linux & BSD

gh is available via Homebrew, Conda, Spack, and as downloadable binaries from the releases page.

For instructions on specific distributions and package managers, see Linux & BSD installation.

Windows

gh is available via WinGet, scoop, Chocolatey, Conda, and as downloadable MSI.

WinGet

Install: Upgrade:
winget install --id GitHub.cli winget upgrade --id GitHub.cli

scoop

Install: Upgrade:
scoop install gh scoop update gh

Chocolatey

Install: Upgrade:
choco install gh choco upgrade gh

Signed MSI

MSI installers are available for download on the releases page.

GitHub Actions

GitHub CLI comes pre-installed in all GitHub-Hosted Runners.

Other platforms

Download packaged binaries from the releases page.

Build from source

See here on how to build GitHub CLI from source.

Comparison with hub

For many years, hub was the unofficial GitHub CLI tool. gh is a new project that helps us explore what an official GitHub CLI tool can look like with a fundamentally different design. While both tools bring GitHub to the terminal, hub behaves as a proxy to git, and gh is a standalone tool. Check out our more detailed explanation to learn more.