Commit graph

221 commits

Author SHA1 Message Date
Andy Feller
5b9324bb46 PR feedback from @bagtoad 2025-08-11 16:50:12 -04:00
Andy Feller
2faba515d8
Apply suggestion from @Copilot
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-08 14:59:35 -04:00
Andy Feller
19410112c4
Update docs/install_windows.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-08 14:58:50 -04:00
Andy Feller
63462f8e40 Consolidate repo profile, fix headings
After discussing changes with @bagtoad, we talked about consolidating the top-level readme further to reduce the amount of links.

Additionally, the Amazon Linux 2 and openSUSE/SUSE sections weren't contained appropriately in the official sections.
2025-08-08 14:21:25 -04:00
Andy Feller
2b11fff6dc markdown lint fixes 2025-08-07 20:31:17 -04:00
Andy Feller
d992d51b6e Formatting 2025-08-07 20:26:33 -04:00
Andy Feller
60af6bcb49 Initial installation doc refactor
These changes work to improve GitHub CLI users experience by bringing:

- clarity between official and unofficial installation methods
- insight into unofficial installation methods
- consistency across supported operating systems
2025-08-07 20:15:46 -04:00
Andy Feller
d0337704df
Merge pull request #11060 from cli/andyfeller/cli-primer-prototype
Reinstating Primer Style CLI content within `cli/cli` repository
2025-07-05 15:02:16 -04:00
Tobias Klauser
fbb749613a docs: consistently use apt in installation instructions
Don't mix apt and apt-get, consistently use apt.
2025-07-03 15:16:07 +02:00
Stefan Heimersheim
e062330163
Fix inconsistent use of tabs and spaces
The code below used spaces to indent two of the lines, and tabs for the other 6 lines. This makes indenting inconsistent in settings where tabs are not rendered as 8 spaces. I've replaced the spaces with tabs.

```
(type -p wget >/dev/null || (sudo apt update && sudo apt-get install wget -y)) \
	&& sudo mkdir -p -m 755 /etc/apt/keyrings \
        && out=$(mktemp) && wget -nv -O$out https://cli.github.com/packages/githubcli-archive-keyring.gpg \
        && cat $out | sudo tee /etc/apt/keyrings/githubcli-archive-keyring.gpg > /dev/null \
	&& sudo chmod go+r /etc/apt/keyrings/githubcli-archive-keyring.gpg \
	&& sudo mkdir -p -m 755 /etc/apt/sources.list.d \
	&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
	&& sudo apt update \
	&& sudo apt install gh -y
```
2025-07-01 11:43:04 +01:00
Kynan Ware
74d10f8dec Fix missing newline in install_linux.md 2025-06-23 11:16:20 -06:00
Kynan Ware
9ce1aeeb1c
Merge pull request #10823 from chax/install_solus
docs: install_linux.md: add Solus linux install instructions
2025-06-23 10:31:38 -06:00
Kynan Ware
802a75b19a
Apply suggestions from code review 2025-06-23 10:23:10 -06:00
Andy Feller
f7218561be
Merge pull request #11047 from cli/andyfeller/9422-license-compliance
Ensure lint workflow checks whether 3rd party license and code is up to date
2025-06-23 12:06:31 -04:00
Kynan Ware
8541d6e290
Merge branch 'trunk' into install_solus 2025-06-23 09:42:11 -06:00
Andy Feller
b5867208a1 Update missed Go 1.23 references 2025-06-23 09:58:06 -04:00
Andy Feller
11e8a8127d Use make for license generation and checks 2025-06-20 16:53:11 -04:00
Andy Feller
98ea250ede Merge branch 'trunk' into andyfeller/9422-license-compliance 2025-06-20 16:23:00 -04:00
William Martin
b5613cdbbe
Merge pull request #10699 from laffer1/patch-1
Add instructions for MidnightBSD installation
2025-06-17 16:55:53 +02:00
William Martin
6b36060d58
Update docs/install_linux.md 2025-06-17 16:43:25 +02:00
Vibhakar Solanki
1ac3f064f3 docs: update install command for Debian
Make sure that `sources.list.d` exists before trying to populate `github-cli.list`
2025-06-17 16:39:58 +02:00
Andy Feller
4ba6d05256 Primer formatting 2025-06-02 16:18:25 -04:00
Andy Feller
180f629cd7 Fix spacing 2025-06-02 16:13:27 -04:00
Andy Feller
3008abae71 Add missing files 2025-06-02 16:11:31 -04:00
Andy Feller
a9468ae535 Rename READMEs
Help content automatically render
2025-06-02 16:10:51 -04:00
Andy Feller
e6cc90a346 Initial restore of Primer CLI docs
This commit brings the https://github.com/primer/cli/ content into the repository for contributors and maintainers.

Minimal changes to the original content have been made as this is being hosted as pure markdown.
2025-06-02 16:08:28 -04:00
Andy Feller
bd24865076 Adopt license compliance scripts into workflows, docs
This commit introduces the use of `go-licenses` within CI/CD and manual processes for generating / updating the license information used by GitHub CLI including the code required by license to be redistributed.

During GitHub CLI pull requests, the `lint` workflow will notify users if this information is not updated.
2025-05-30 12:46:51 -04:00
chax
6740f6d1c2
docs: install_linux.md: add Solus linux install instructions 2025-04-18 01:38:32 +02:00
Lucas Holt
af87389a19 Add instructions for MidnightBSD installation 2025-04-02 09:09:36 -04:00
Azeem Sajid
f3e4976da3 ./script/sign cleanup 2025-03-14 11:51:09 +05:00
William Martin
b8cf16dc2d
Deep Dive Document Release Process (#10503) 2025-03-04 13:30:29 +01:00
Andy Feller
4cf0901b87 Update release doc content
- simplifying certain language
- updating content around scheduled formula workflow process that makes new versions available
2025-02-06 18:12:42 -05:00
Azeem Sajid
abe6d8dd30 [docs/releasing.md] Add basic info for homebrew update flow 2025-01-31 13:18:46 +05:00
William Martin
c3342cc173
Merge pull request #10236 from AMS21/patch-1
add install instructions for Manjaro Linux
2025-01-22 12:59:17 +01:00
William Martin
113fe646f3 Bump go module version to 1.23 2025-01-22 12:10:03 +01:00
AMS21
960f533234
add install instructions for Manjaro Linux 2025-01-13 20:01:28 +01:00
Tyler McGoffin
47c391b246 PR review edits 2025-01-07 15:42:17 -08:00
Tyler McGoffin
58ca3c69bb Update triage.md to reflect FR experiment outcome 2025-01-07 10:36:15 -08:00
Andy Feller
0e191ef0f2
Update releasing.md 2024-12-20 15:34:26 -05:00
Jonas Grabber
881a2a374c
Improve error handling in apt setup script
`wget -qO- ... | sudo tee` causes any errors from `wget` to be swallowed up, causing an empty keyring file to be configured.

For us, the local Ubuntu setup did not have `ca-certificates` installed, which caused `wget` to error out because of a authentication errors (untrusted certificate). However, the `-q` flag and the pipe into `tee` prevented the error from showing up or halting the script.

This PR turns on non-verbose output for `wget` and adds a proper short-circuit on the return code of it by storing the keyring in a temporary file first.
2024-12-10 15:49:55 +01:00
Kynan Ware
4f4602a682 Improve DNF version clarity in install steps 2024-11-29 16:34:41 -07:00
Miroma
a3f353d2f7
Set dnf5 commands as default
Fedora 41 is now stable! 🎉

Closes #9840

Co-authored-by: Melamit64 <151834564+melamit@users.noreply.github.com>
2024-10-29 09:52:03 +01:00
bagtoad
abb2772696 Use new GitHub preview terms in working-with-us.md
Update the "working with us" docs to align with new GitHub previews terminology, replacing `beta` with `public preview`.

https://github.blog/changelog/2024-10-18-new-terminology-for-github-previews/
2024-10-22 10:56:39 -06:00
Kynan Ware
289b9bc712
Apply suggestions from code review
Co-authored-by: Tyler McGoffin <jtmcg@github.com>
2024-10-01 17:24:23 -06:00
bagtoad
89628a40f9 fix typo 2024-09-30 15:13:43 -06:00
bagtoad
aef01e22d7 Revise wording 2024-09-30 15:03:50 -06:00
bagtoad
0b29beacf4 Update docs to allow community submitted designs 2024-09-30 14:47:24 -06:00
Miroma
4de63ac75b
Include dnf5 commands 2024-09-28 07:58:14 +02:00
Miroma
c843dddf0d
Add GPG key instructions to appropriate sections 2024-09-25 21:55:29 +02:00
Andy Feller
5a7cdff9db Update linux install to point to GPG troubleshoot
Relates #9569

Updates notes from older 2 year GPG ID change to redirect users in case of GPG errors to recent issue.
2024-09-06 08:45:24 -04:00