jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 02:46:50 -05:00
Code Issues Projects Releases Wiki Activity

Add CLI content to handul of articles (#19810)

Browse Source 
* move workflow disable content to tool selector

* add cli tab to workflow articles

* seeing if this works

* add reusable

* update for each platform

* update with flags

* update with product switchers

* update with end tag

* add cli tab

* update with cli and desktop tabs

* add desktop and cli tabs

* remove tip

* get tests passing

* last small updates

* fix break

* remove break maybe

* update with download link reusable

* update with download resuable

* resolve feedback

* quotes around string

* flesh this out a bit more

* remove reusable

* update with more feedback

Co-authored-by: Meg Bird <megbird@github.com>
This commit is contained in:
Sarah Edwards
2021-07-01 06:40:44 -07:00
committed by GitHub
parent af158bc17d
commit 4b5cfca433
11 changed files with 320 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
content/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md
View File

@@ -20,16 +20,11 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
{% data reusables.ssh.dsa-support %}
{% ifversion fpt or ghae or ghes %}
{% tip %}
**Tip**: You can also add an SSH key using the {% data variables.product.prodname_cli %}. For more information, see "[`gh ssh-key add`](https://cli.github.com/manual/gh_ssh-key_add)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %}
{% endif %}
{% mac %}
{% include tool-switcher %}
{% webui %}
1. Copy the SSH public key to your clipboard.
If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
@@ -56,10 +51,16 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
![The Add key button](/assets/images/help/settings/ssh-add-key.png)
{% data reusables.user_settings.sudo-mode-popup %}
{% endwebui %}
{% endmac %}
{% windows %}
{% include tool-switcher %}
{% webui %}
1. Copy the SSH public key to your clipboard.
If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
@@ -87,10 +88,15 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
8. If prompted, confirm your {% data variables.product.product_name %} password.
![Sudo mode dialog](/assets/images/help/settings/sudo_mode_popup.png)
{% endwebui %}
{% endwindows %}
{% linux %}
{% include tool-switcher %}
{% webui %}
1. Copy the SSH public key to your clipboard.
If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace.
@@ -121,8 +127,28 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc
8. If prompted, confirm your {% data variables.product.product_name %} password.
![Sudo mode dialog](/assets/images/help/settings/sudo_mode_popup.png)
{% endwebui %}
{% endlinux %}
{% cli %}
{% data reusables.cli.download-cli %}
To add an SSH key to your GitHub account, use the `ssh-key add` subcommand.
```shell
gh ssh-key add <em>key-file</em>
```
To include a title for the new key, use the `-t` or `--title` flag.
```shell
gh ssh-key add <em>key-file</em> --title "personal laptop"
```
{% endcli %}
{% ifversion fpt %}
## Further reading

104
content/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md
View File

@@ -20,14 +20,6 @@ You can specify which branch you'd like to merge your changes into when you crea
{% data reusables.pull_requests.close-issues-using-keywords %}
{% ifversion fpt or ghae or ghes %}
{% tip %}
**Tip**: You can create a pull request using the {% data variables.product.prodname_cli %}. For more information, see "[`gh pr create`](https://cli.github.com/manual/gh_pr_create)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %}
{% endif %}
## Changing the branch range and destination repository
By default, pull requests are based on the parent repository's default branch. For more information, see "[About branches](/github/collaborating-with-issues-and-pull-requests/about-branches#about-the-default-branch)."
@@ -52,11 +44,9 @@ When you change any of the information in the branch range, the Commit and Files
## Creating the pull request
{% tip %}
{% include tool-switcher %}
**Tip**: You can also use {% data variables.product.prodname_desktop %} to create a pull request. For more information, see “[Creating an issue or pull request](/desktop/contributing-to-projects/creating-an-issue-or-pull-request)" in the {% data variables.product.prodname_desktop %} documentation.
{% endtip %}
{% webui %}
{% data reusables.repositories.navigate-to-repo %}
2. In the "Branch" menu, choose the branch that contains your commits.
@@ -71,6 +61,96 @@ When you change any of the information in the branch range, the Commit and Files
After your pull request has been reviewed, it can be [merged into the repository](/articles/merging-a-pull-request).
{% endwebui %}
{% cli %}
{% data reusables.cli.download-cli %}
To create a pull request, use the `gh pr create` subcommand.
```shell
gh pr create
```
To assign a pull request to an individual, use the `--assignee` or `-a` flags. You can use `@me` to self-assign the pull request.
```shell
gh pr create --assignee "@octocat"
```
To specify the branch into which you want the pull request merged, use the `--base` or `-B` flags. To specify the branch that contains commits for your pull request, use the `--head` or `-H` flags.
```shell
gh pr create --base my-base-branch --head my-changed-branch
```
To include a title and body for the new pull request, use the `--title` and `--body` flags.
```shell
gh pr create --title "The bug is fixed" --body "Everything works again"
```
To mark a pull request as a draft, use the `--draft` flag.
```shell
gh pr create --draft
```
To add a labels or milestones to the new pull request, use the `--label` and `--milestone` flags.
```shell
gh pr create --label "bug,help wanted" --milestone octocat-milestone
```
To add the new pull request to a specific project, use the `--project` flag.
```shell
gh pr create --project octocat-project
```
To assign an individual or team as reviewers, use the `--reviewer` flag.
```shell
gh pr create --reviewer monalisa,hubot --reviewer myorg/team-name
```
To create the pull request in your default web browser, use the `--web` flag.
```shell
gh pr create --web
```
{% endcli %}
{% desktop %}
{% mac %}
1. Switch to the branch that you want to create a pull request for. For more information, see "[Switching between branches](/desktop/contributing-and-collaborating-using-github-desktop/managing-branches#switching-between-branches)."
2. Click **Create Pull Request**. {% data variables.product.prodname_desktop %} will open your default browser to take you to {% data variables.product.prodname_dotcom %}.
![The Create Pull Request button](/assets/images/help/desktop/mac-create-pull-request.png)
4. On {% data variables.product.prodname_dotcom %}, confirm that the branch in the **base:** drop-down menu is the branch where you want to merge your changes. Confirm that the branch in the **compare:** drop-down menu is the topic branch where you made your changes.
![Drop-down menus for choosing the base and compare branches](/assets/images/help/desktop/base-and-compare-branches.png)
{% data reusables.repositories.pr-title-description %}
{% data reusables.repositories.create-pull-request %}
{% endmac %}
{% windows %}
1. Switch to the branch that you want to create a pull request for. For more information, see "[Switching between branches](/desktop/contributing-and-collaborating-using-github-desktop/managing-branches#switching-between-branches)."
2. Click **Create Pull Request**. {% data variables.product.prodname_desktop %} will open your default browser to take you to {% data variables.product.prodname_dotcom %}.
![The Create Pull Request button](/assets/images/help/desktop/windows-create-pull-request.png)
3. On {% data variables.product.prodname_dotcom %}, confirm that the branch in the **base:** drop-down menu is the branch where you want to merge your changes. Confirm that the branch in the **compare:** drop-down menu is the topic branch where you made your changes.
![Drop-down menus for choosing the base and compare branches](/assets/images/help/desktop/base-and-compare-branches.png)
{% data reusables.repositories.pr-title-description %}
{% data reusables.repositories.create-pull-request %}
{% endwindows %}
{% enddesktop %}
## Further reading
- "[Creating a pull request from a fork](/articles/creating-a-pull-request-from-a-fork)"

34
content/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository.md
View File

@@ -19,15 +19,11 @@ Cloning a repository pulls down a full copy of all the repository data that {% d
You can clone your existing repository or clone another person's existing repository to contribute to a project.
{% ifversion fpt or ghae or ghes %}
{% tip %}
## Cloning a repository
**Tip**: You can also clone a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo clone`](https://cli.github.com/manual/gh_repo_clone)" in the {% data variables.product.prodname_cli %} documentation.
{% include tool-switcher %}
{% endtip %}
{% endif %}
## Cloning a repository using the command line
{% webui %}
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.copy-clone-url %}
@@ -36,7 +32,27 @@ You can clone your existing repository or clone another person's existing reposi
{% data reusables.command_line.git-clone-url %}
{% data reusables.command_line.local-clone-created %}
## Cloning a repository to {% data variables.product.prodname_desktop %}
{% endwebui %}
{% cli %}
{% data reusables.cli.download-cli %}
To clone a repository locally, use the `repo clone` subcommand. Replace the `repository` parameter with the repository name. For example, `octo-org/octo-repo`, `monalisa/octo-repo`, or `octo-repo`. If the `OWNER/` portion of the `OWNER/REPO` repository argument is omitted, it defaults to the name of the authenticating user.
```shell
gh repo clone <em>repository</em>
```
You can also use the GitHub URL to clone a repository.
```shell
gh repo clone <em>https://github.com/cli/cli</em>
```
{% endcli %}
{% desktop %}
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.open-with-github-desktop %}
@@ -44,6 +60,8 @@ You can clone your existing repository or clone another person's existing reposi
For more information, see "[Cloning a repository from {% data variables.product.prodname_dotcom %} to {% data variables.product.prodname_desktop %}](/desktop/guides/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop/)."
{% enddesktop %}
## Cloning an empty repository
An empty repository contains no files. It's often made if you don't initialize the repository with a README when creating it.