Commit graph

39 commits

Author SHA1 Message Date
Andy Feller
d7e2468286 Update a11y text based on draft feedback 2025-04-28 15:01:15 -04:00
Andy Feller
274a09bbc9 Initial gh accessibility command draft
This commit captures the initial command along with functionality and description.

There is an internal discussion about the appropriate place for some of this content.
2025-04-23 10:11:51 -04:00
Andy Feller
addbc6ac5c Add label color env var to help topic, unused fix
This commit adds the new environment variable to the `gh environment` help topic.

Additionally, there is a small fix for Go linter for an unused variable raised as a problem.
2025-04-04 11:02:44 -04:00
Prabhat Kumar Sahu
1886fb46ab
Fix pr checks exit code (#9452)
* Enhance  with exit code documentation

* Add new error message for PR check

* Refine gh pr checks: Add exit code 8

* Update EXIT CODES section format in man page generation
2024-08-16 14:30:11 -07:00
gabemontero
39e4cbd973 update generated content for man pages and website 2024-05-17 09:30:53 -04:00
gabemontero
77f964aa12 williammartin simplifications 2024-05-17 09:30:53 -04:00
gabemontero
c265753275 remove no-op if clause that returns 'No Aliases' 2024-05-17 09:30:53 -04:00
Andy Feller
7dd35e7470 Conditionalize references, remove redundant alias
This commit adds conditional logic in `gh reference` to only show aliases if
there are aliases to see.  Additionally, this removes the unaliased command
name from being shown under aliases.
2024-05-17 09:30:53 -04:00
gabemontero
dd7ea5adff list the various alias permutations for the command and subcommands
this occurs from either utlizing the help function for a specific command/subcommand
combination or when 'gh reference' lists the command tree
2024-05-17 09:30:53 -04:00
Babak K. Shandiz
9f9d0415da
Output JSON FIELDS
Signed-off-by: Babak K. Shandiz <babak.k.shandiz@gmail.com>
2024-05-06 17:55:46 +01:00
Andy Feller
c47c1db376
Merge pull request #8367 from Rebeccasun31/show_aliases
Documentation for built-in aliases
2024-02-08 14:05:05 -05:00
Andy Feller
152ab207b5 For lint sake 2023-12-01 09:20:44 -05:00
Andy Feller
a9e430e9bc Fix lint warning 2023-12-01 09:16:51 -05:00
Andy Feller
b77de0d458 Additional formatting changes
- gh help actions
  - highlight 3 commands to run for more information
- gh extension
  - wrapping url for online linking
  - fix install subcommand missing backtick formatting
- gh release create
  - fixing mixed indenting causing usage misalignment
- root help
  - backtick wrap help command for more info for consistency
- gh help environment
  - backtick wrap missed OWNER/REPO
- gh variable
  - brought consistency to output when deleting or setting variable
2023-12-01 09:08:51 -05:00
rebeccasun31
6509ba72df Documentation for built-in aliases 2023-11-23 00:30:13 +08:00
Sam Coe
1c3c402377
Do not generate docs for aliases (#7497) 2023-05-28 00:27:31 +00:00
Sam Coe
74ee8cacae
Allow creating of nested aliases (#7457) 2023-05-25 09:46:45 +09:00
William Martin
07ed1e4e8a
Introduce helpTopics type and reduce duplication across commands (#7414) 2023-05-11 14:59:12 +02:00
Mislav Marohnić
b3aeaf6c2e
Remove the feedback section from gh help 2022-11-09 16:43:18 +01:00
Mislav Marohnić
b12ea845ef
Migrate to the new Cobra command grouping feature 2022-11-09 16:42:13 +01:00
Sam Coe
e7102f9d84
Migrate to go-gh text package (#6236) 2022-09-14 09:23:55 +04:00
Mislav Marohnić
cfaca91d06 Fix --version flag printing to stdout 2022-05-24 16:21:13 +02:00
Mislav Marohnić
2139e763fb Write Cobra deprecation messages to stderr
We used to do the equivalent of `rootCmd.SetOut(os.Stdout)` because we
thought that Cobra's "Out" stream represents standard output. However,
upon closer inspection it turns out that this is Cobra's stream for
usage errors and deprecation warnings, and those we want written to
stderr as well. It is not clear to me why Cobra maintains a distinction
between "Out" and "Err" streams since both seem to go to sdterr by
default.

This change also ceases our usage of `command.Print()` functions in
favor of explicitly writing to `IOStreams.Out/ErrOut`.
2022-05-23 20:23:42 +02:00
Sam Coe
2c0236d096
Add extension upgrade --dry-run (#5098) 2022-04-12 07:18:08 +00:00
Mislav Marohnić
7235384f12 gh: list help topics in help output 2022-02-18 18:39:30 +01:00
Alan Donovan
f4491c7a80 Add FlagErrorf; encapsulate FlagError.error 2021-10-21 11:40:20 -04:00
Mislav Marohnić
11fbb60ae7 Rename the module to "github.com/cli/cli/v2" 2021-08-25 12:41:30 +02:00
Mislav Marohnić
0d999ddaa1 Rework local extensions for Windows
Replace the implementation that relied on symlinks with the one that
create regular files that act like symlinks: they contain a reference to
the local directory where to find the extension.
2021-07-28 22:47:54 +02:00
Mislav Marohnić
1ec47d8191 Improvements to gh extensions
- Extensions on Windows now enabled through the `sh.exe` interpreter
- `sh.exe` now found on Windows when git was installed via scoop
- `gh extensions list` command shows origin repo for the extension
- `gh extensions upgrade --all` is required to upgrade all extensions
- Added `gh extensions remove`
- Shell completions now include aliases and extension names
- `gh` help output now lists available extension names
- Extensions are stored to XDG_DATA_HOME
2021-06-21 16:54:08 +02:00
Mislav Marohnić
e327b42f79 Add gh help formatting topic & link to it from commands with JSON output 2021-04-14 18:27:15 +02:00
Sam Coe
8b1ed28121
Add section in help for actions commands 2021-04-01 21:05:50 -07:00
Josh Soref
76bd377253 spelling: error 2020-11-21 21:43:51 -05:00
vilmibm
a2aa154794 port entirely to ColorScheme 2020-10-29 12:37:45 -07:00
Sam Coe
53a97c3414
Extract rootFlagErrrorFunc into root help 2020-09-30 12:49:17 +02:00
Sam Coe
21449213e5
Expand help topic functionality 2020-09-14 17:50:50 +02:00
Mislav Marohnić
3c32507a13 Consistent use of quotes to delineate commands to be run 2020-09-14 16:26:23 +02:00
Mislav Marohnić
aa72463114 Extract environment as a separate help topic
Co-authored-by: Sam Coe <samcoe@github.com>
2020-09-14 16:25:30 +02:00
Mislav Marohnić
f7d0988799 Offer different editor modes during release create 2020-08-25 20:20:44 +02:00
Mislav Marohnić
aef1a4ba4d Extract root command and factory logic into separate packages 2020-08-07 14:40:33 +02:00
Renamed from command/help.go (Browse further)