diff --git a/assets/images/help/desktop/branch-drop-down-pull-request-tab.png b/assets/images/help/desktop/branch-drop-down-pull-request-tab.png index 57f10ab13f..5b9f00d426 100644 Binary files a/assets/images/help/desktop/branch-drop-down-pull-request-tab.png and b/assets/images/help/desktop/branch-drop-down-pull-request-tab.png differ diff --git a/assets/images/help/desktop/checks-dialog.png b/assets/images/help/desktop/checks-dialog.png new file mode 100644 index 0000000000..6e56489139 Binary files /dev/null and b/assets/images/help/desktop/checks-dialog.png differ diff --git a/assets/images/help/desktop/checks-failed-dialog.png b/assets/images/help/desktop/checks-failed-dialog.png new file mode 100644 index 0000000000..5d8571ac61 Binary files /dev/null and b/assets/images/help/desktop/checks-failed-dialog.png differ diff --git a/assets/images/help/desktop/click-pull-request.png b/assets/images/help/desktop/click-pull-request.png index 14af96e9e0..052ae1e765 100644 Binary files a/assets/images/help/desktop/click-pull-request.png and b/assets/images/help/desktop/click-pull-request.png differ diff --git a/assets/images/help/desktop/mac-enable-notifications.png b/assets/images/help/desktop/mac-enable-notifications.png new file mode 100644 index 0000000000..f26bf845e8 Binary files /dev/null and b/assets/images/help/desktop/mac-enable-notifications.png differ diff --git a/assets/images/help/desktop/pull-request-checks-failed-notification.png b/assets/images/help/desktop/pull-request-checks-failed-notification.png new file mode 100644 index 0000000000..27bfa863f2 Binary files /dev/null and b/assets/images/help/desktop/pull-request-checks-failed-notification.png differ diff --git a/assets/images/help/desktop/pull-request-list-sync.png.png b/assets/images/help/desktop/pull-request-list-sync.png.png new file mode 100644 index 0000000000..87a480c5ce Binary files /dev/null and b/assets/images/help/desktop/pull-request-list-sync.png.png differ diff --git a/assets/images/help/desktop/pull-request-review-dialog.png b/assets/images/help/desktop/pull-request-review-dialog.png new file mode 100644 index 0000000000..e1a272291c Binary files /dev/null and b/assets/images/help/desktop/pull-request-review-dialog.png differ diff --git a/assets/images/help/desktop/pull-request-review-notification.png b/assets/images/help/desktop/pull-request-review-notification.png new file mode 100644 index 0000000000..7d040ac580 Binary files /dev/null and b/assets/images/help/desktop/pull-request-review-notification.png differ diff --git a/assets/images/help/desktop/re-run-confirmation-dialog.png b/assets/images/help/desktop/re-run-confirmation-dialog.png new file mode 100644 index 0000000000..9a6aa72dbf Binary files /dev/null and b/assets/images/help/desktop/re-run-confirmation-dialog.png differ diff --git a/assets/images/help/desktop/re-run-failed-checks.png b/assets/images/help/desktop/re-run-failed-checks.png new file mode 100644 index 0000000000..8df302e21d Binary files /dev/null and b/assets/images/help/desktop/re-run-failed-checks.png differ diff --git a/assets/images/help/desktop/re-run-individual-checks.png b/assets/images/help/desktop/re-run-individual-checks.png new file mode 100644 index 0000000000..1147c864bf Binary files /dev/null and b/assets/images/help/desktop/re-run-individual-checks.png differ diff --git a/assets/images/help/desktop/windows-enable-notifications.png b/assets/images/help/desktop/windows-enable-notifications.png new file mode 100644 index 0000000000..650446c57f Binary files /dev/null and b/assets/images/help/desktop/windows-enable-notifications.png differ diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project.md b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project.md index d685c0ca15..2cb8b56fab 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project.md @@ -31,8 +31,8 @@ To change how you view diffs, in the top-right corner of the diff view, click {% ![Diff option menu](/assets/images/help/desktop/diff-selection.png) -If you need to see more of the file than {% data variables.product.prodname_desktop %} shows by default, you can expand the diff. -- To see the next few lines above or below the highlighted changes, click the arrow above or below the line numbers. +If you need to see more of the file than {% data variables.product.prodname_desktop %} shows by default, you can expand the diff. +- To see the next few lines above or below the highlighted changes, click the arrow above or below the line numbers. - To see the entire file, right-click in the diff view and click **Expand Whole File**. ![Expand diff view](/assets/images/help/desktop/expand-diff-view.png) @@ -122,3 +122,11 @@ Once you're satisfied with the changes you've chosen to include in your commit, ![Protected branch warning](/assets/images/help/desktop/protected-branch-warning.png) {% data reusables.desktop.push-origin %} + +6. If you have a pull request based off the branch you are working on, {% data variables.product.prodname_desktop %} will display the status of the checks that have run for the pull request. For more information about checks, see "[Viewing and re-running checks in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)." + + ![Checks display next to branch name](/assets/images/help/desktop/checks-dialog.png) + + If a pull request has not been created for the current branch, {% data variables.product.prodname_desktop %} will give you the option to create one. For more information, see "[Creating an issue or pull request](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/creating-an-issue-or-pull-request)." + + ![Creating a pull request](/assets/images/help/desktop/mac-create-pull-request.png) diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md new file mode 100644 index 0000000000..23ffff371a --- /dev/null +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop.md @@ -0,0 +1,62 @@ +--- +title: Configuring notifications in GitHub Desktop +shortTitle: Configuring notifications +intro: '{% data variables.product.prodname_desktop %} will keep you up-to-date with notifications about events that occur in your pull request branch.' +versions: + fpt: '*' +--- +## About notifications in {% data variables.product.prodname_desktop %} + +{% data variables.product.prodname_desktop %} will show a system notification for events that occur in the currently selected repository. Notifications will be shown when: + +- Pull request checks have failed. +- A pull request review is left with a comment, approval, or requested changes. + +Clicking the notification will switch application focus to {% data variables.product.prodname_desktop %} and provide more detailed information. + +## Notifications about pull request check failures + +When changes are made to a pull request branch, you will receive a notification if the checks fail. + +![pull request checks failed notification](/assets/images/help/desktop/pull-request-checks-failed-notification.png) + +Clicking the notification will display a dialog with details about the checks. Once you've reviewed why the checks have failed, you can re-run the checks, or quickly switch to the pull request branch to get started on fixing the errors. For more information, see "[Viewing and re-running checks in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)." + +![checks failed dialog](/assets/images/help/desktop/checks-failed-dialog.png) +## Notifications for pull request reviews + +{% data variables.product.prodname_desktop %} will surface a system notification when a teammate has approved, commented, or requested changes in your pull request. See "[About pull request reviews](/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)" for more information on pull request reviews. + +![Pull request review notification](/assets/images/help/desktop/pull-request-review-notification.png) + +Clicking the notification will switch application focus to {% data variables.product.prodname_desktop %} and provide more context for the pull request review comment. + +![pull request review dialog](/assets/images/help/desktop/pull-request-review-dialog.png) +## Enabling notifications + +If system notifications are disabled for {% data variables.product.prodname_desktop %} you can follow the steps below to enable them. + +{% mac %} + +1. Click the **Apple** menu, then select **System Preferences**. +2. Select **Notifications & Focus**. +3. Select **{% data variables.product.prodname_desktop %}** from the list of applications. +4. Click **Allow Notifications**. + +![macOS Notifications & Focus](/assets/images/help/desktop/mac-enable-notifications.png) + +For more information about macOS system notifications, see "[Use notifications on your Mac](https://support.apple.com/en-us/HT204079)." + +{% endmac %} + +{% windows %} + +1. Open the **Start** menu, then select **Settings**. +2. Select **System**, then click **Notifications**. +3. Find **{% data variables.product.prodname_desktop %}** in the application list and click **On**. + +![Enable Windows Notifications](/assets/images/help/desktop/windows-enable-notifications.png) + +For more information about Windows system notifications, see "[Change notification settings in Windows](https://support.microsoft.com/en-us/windows/change-notification-settings-in-windows-8942c744-6198-fe56-4639-34320cf9444e)." + +{% endwindows %} \ No newline at end of file diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/index.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/index.md index fbd4c10c20..82b7de9176 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/index.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/index.md @@ -8,6 +8,8 @@ versions: children: - /creating-an-issue-or-pull-request - /viewing-a-pull-request-in-github-desktop + - /viewing-and-re-running-checks-in-github-desktop + - /configuring-notifications-in-github-desktop - /changing-a-remotes-url-from-github-desktop shortTitle: Work with your remote repo --- diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md index cbbd24efa4..1bf3e5724a 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-a-pull-request-in-github-desktop.md @@ -14,6 +14,8 @@ You can view pull requests that you or your collaborators have proposed in {% da When you view a pull request in {% data variables.product.prodname_desktop %}, you can see a history of commits that contributors made. You can also see which files the commits modified, added, or deleted. From {% data variables.product.prodname_desktop %}, you can open repositories in your preferred text editor to view any changes or make additional changes. After reviewing changes in a pull request, you can give feedback on {% data variables.product.prodname_dotcom %}. For more information, see "[About pull request reviews](/github/collaborating-with-issues-and-pull-requests/about-pull-request-reviews)." +If checks have been enabled in your repository, {% data variables.product.prodname_desktop %} will show the status of the checks on the pull request and allow you to re-run checks. For more information, see "[Viewing and re-running checks in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)." + ## Viewing a pull request in {% data variables.product.prodname_desktop %} {% data reusables.desktop.current-branch-menu %} {% data reusables.desktop.click-pull-requests %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md new file mode 100644 index 0000000000..b6f77b98f0 --- /dev/null +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md @@ -0,0 +1,28 @@ +--- +title: Viewing and re-running checks in GitHub Desktop +shortTitle: Viewing and re-running checks +intro: 'You can view the status of checks and re-run them in {% data variables.product.prodname_desktop %}.' +versions: + fpt: '*' +--- +## About checks in {% data variables.product.prodname_desktop %} + +{% data variables.product.prodname_desktop %} displays the status of checks that have run in your pull request branches. The checks badge next to the branch name will display the *pending, passing,* or *failing* state of the checks. You can also re-run all, failed, or individual checks when viewing the status of the checks in {% data variables.product.prodname_desktop %}. For more information on setting up checks in your repository, see "[About status checks](/github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." + +{% data variables.product.prodname_desktop %} will also show a system notification when checks fail. For more information on enabling notifications, see "[Configuring notifications in GitHub Desktop](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop)." + +## Viewing and re-running checks + +{% data reusables.desktop.current-branch-menu %} +{% data reusables.desktop.click-pull-requests %} + ![Pull Requests tab in the Current Branch drop-down menu](/assets/images/help/desktop/branch-drop-down-pull-request-tab.png) +{% data reusables.desktop.choose-pr-from-list %} + ![List of open pull requests in the repository](/assets/images/help/desktop/click-pull-request.png) +4. Click on the pull request number, to the right of the pull request branch name. + ![Checks display next to branch name](/assets/images/help/desktop/checks-dialog.png) +5. To re-run failed checks, click **{% octicon "sync" aria-label="The sync icon" %} Re-run** and select **Re-run Failed Checks**. + ![Re-run failed checks](/assets/images/help/desktop/re-run-failed-checks.png) +6. To re-run individual checks, hover over the individual check you want to re-run and select the {% octicon "sync" aria-label="The sync icon" %} icon to re-run the check. + ![Re-run individual checks](/assets/images/help/desktop/re-run-individual-checks.png) +7. You will see a confirmation dialog with the summary of the checks that will be re-run. Click **Re-run Checks** to confirm that you want to perform the re-run. + ![Re-run confirmation dialog](/assets/images/help/desktop/re-run-confirmation-dialog.png) \ No newline at end of file