Commit graph

24 commits

Author SHA1 Message Date
Kynan Ware
b8ee5c5eba Add godoc comments to exported symbols in remaining packages
Add documentation comments to exported symbols across all remaining
smaller packages including cmd/gen-docs, context, internal/browser,
internal/gh, internal/ghcmd, internal/ghinstance, internal/ghrepo,
internal/keyring, internal/run, internal/safepaths, internal/tableprinter,
internal/text, internal/update, pkg/cmd/accessibility, pkg/cmd/actions,
pkg/cmd/alias, pkg/cmd/api, pkg/cmd/browse, pkg/cmd/cache,
pkg/cmd/completion, pkg/cmd/copilot, pkg/cmd/factory, pkg/cmd/gpg-key,
pkg/cmd/label, pkg/cmd/licenses, pkg/cmd/org, pkg/cmd/preview,
pkg/cmd/ssh-key, pkg/cmd/version, pkg/extensions, pkg/jsoncolor,
pkg/markdown, pkg/option, pkg/set, pkg/ssh, pkg/surveyext, test,
internal/authflow, and utils.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-03-04 16:14:20 -07:00
Andrew Feller
a55f50b115 Remove Extension.FullName() from interface
- this was something I did in the original implementation of this improved extension update notification logic
- discovering other parts of the extension manager code that were working with non-prefixed extension names motivated a different approach
- the extension manager code that requires the extension be prefixed has been enhanced to use the centralized ensurePrefixed() logic, making the need for this on the extension unnecessary
2024-12-08 20:01:26 -05:00
William Martin
1d38230675
Move config interfaces into gh package (#9060) 2024-05-10 10:39:36 +02:00
Mikel Olasagasti Uranga
46a7042b88
Bump cpuguy83/go-md2man from 2.0.1 to 2.0.3 (#8209)
Version 2.0.3 introduces a fix in PR
https://github.com/cpuguy83/go-md2man/pull/105 that breaks a test for
gen-doc, thus requires a small change in the test.
2023-10-18 07:17:20 +00: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
Håvard Anda Estensen
58cb773e09
Replace ioutil with io and os (#5498) 2022-04-26 13:07:44 +02:00
Mislav Marohnić
31c7181297 Refresh man pages
- Fix name of man pages for all but the toplevel command
- Set title of all man pages to "GitHub CLI manual"
- Include gh version information in man pages
- Clean up rendering of flags section
- List subcommands for every command
2021-12-20 18:11:31 +01:00
Mislav Marohnić
11fbb60ae7 Rename the module to "github.com/cli/cli/v2" 2021-08-25 12:41:30 +02:00
Mislav Marohnić
71c2bc5807 Add tests for manual pages generation 2021-03-30 20:47:25 +02:00
Mislav Marohnić
23b2594662 Fix crash when generating man pages
Fixes #3329
2021-03-30 19:59:39 +02:00
Sam Coe
f770c6481c
Generate markdown for help topics 2020-11-04 12:35:58 +03:00
Sam
699c9ae131
Remove Cobra autogenerated string from docs generation 2020-10-22 12:59:11 +02:00
Sam
36949e263a Internalize doc generation from Cobra 2020-10-22 09:38:51 +00:00
Mislav Marohnić
2b9de23637 Extract alias expansion into a separate package 2020-08-11 15:18:48 +02:00
Corey Johnson
e5b78d3342 Fix lint errors 2020-05-20 11:21:05 -07:00
Mark Furland
e13fc2465f use consistent var declaration format 2020-05-19 12:21:20 -04:00
Mark Furland
1cd6e3f9d3 pass some options to GenManTree 2020-05-12 10:17:56 -04:00
Mark Furland
e33706fbf4 Add flags for man vs website to cmd/gen-docs 2020-05-12 09:51:25 -04:00
Mark Furland
92130d91ba Minimal manpage generation from cobra 2020-05-12 09:10:09 -04:00
Mislav Marohnić
030538871d Fix make site-docs 2020-03-03 23:34:32 +01:00
Mislav Marohnić
04aff00798 Update make site-docs to reflect latest setup
- Man pages are now placed under `/manual/`
- Use Jekyll `permalink` to avoid the `.html` extension
- Strip "SEE ALSO" and everything after it
2020-01-31 15:35:57 +01:00
Mislav Marohnić
a710893fc1 Rename to cli/cli 2020-01-24 16:08:52 +01:00
Mislav Marohnić
39080dc332 Generate help docs to GitHub Pages
`make site-docs`:
1. checks out the `gh-pages` branch into the `site/` directory;
2. regenerates `.md` help pages using Cobra;
3. commits and publishes updates.
2019-11-28 16:43:07 +01:00