diff --git a/.github/workflows/codeowners-docs-engineering.yml b/.github/workflows/codeowners-docs-engineering.yml index 3f47e6fe14..7f57991948 100644 --- a/.github/workflows/codeowners-docs-engineering.yml +++ b/.github/workflows/codeowners-docs-engineering.yml @@ -8,6 +8,12 @@ name: Codeowners - Docs Engineering on: pull_request: + types: + - edited + - opened + - ready_for_review + - reopened + - synchronize paths: - '**.js' - '**.ts' @@ -20,7 +26,7 @@ on: jobs: codeowners-docs-engineering: - if: ${{ github.repository == 'github/docs-internal' }} + if: ${{ github.repository == 'github/docs-internal' && !github.event.pull_request.draft }} runs-on: ubuntu-latest env: GH_TOKEN: ${{ secrets.DOCS_BOT_FR }} diff --git a/assets/images/help/desktop/ahead-tab.png b/assets/images/help/desktop/ahead-tab.png new file mode 100644 index 0000000000..4c1c7b079d Binary files /dev/null and b/assets/images/help/desktop/ahead-tab.png differ diff --git a/assets/images/help/desktop/view-pr-on-github.png b/assets/images/help/desktop/view-pr-on-github.png new file mode 100644 index 0000000000..25210219a7 Binary files /dev/null and b/assets/images/help/desktop/view-pr-on-github.png differ diff --git a/assets/images/help/graphs/activity-view-compare-changes.png b/assets/images/help/graphs/activity-view-compare-changes.png new file mode 100644 index 0000000000..e9b0798bd8 Binary files /dev/null and b/assets/images/help/graphs/activity-view-compare-changes.png differ diff --git a/assets/images/help/graphs/activity-view-embedded-link.png b/assets/images/help/graphs/activity-view-embedded-link.png new file mode 100644 index 0000000000..37a72e4888 Binary files /dev/null and b/assets/images/help/graphs/activity-view-embedded-link.png differ diff --git a/assets/images/help/graphs/activity-view-icon.png b/assets/images/help/graphs/activity-view-icon.png new file mode 100644 index 0000000000..061ff2bf45 Binary files /dev/null and b/assets/images/help/graphs/activity-view-icon.png differ diff --git a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md index fb442b1d03..6c923cb679 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md +++ b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md @@ -27,6 +27,11 @@ Push log entries show: - The Git client used to push - The SHA hashes from before and after the operation +{% ifversion repository-activity-view %} +{% data reusables.repositories.activity-view %} +For more information, see "[Using the activity view to see changes to your repository](/enterprise-server@latest/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity#using-the-activity-view-to-see-changes-to-a-repository)." +{% endif %} + ## Viewing a repository's push logs 1. Sign into {% data variables.product.prodname_ghe_server %} as a site administrator. 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 f8b37dbaf5..9f31ab80de 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 @@ -1,7 +1,7 @@ --- title: Viewing a pull request in GitHub Desktop shortTitle: Viewing a pull request -intro: 'You can view proposed changes in open pull requests on {% data variables.product.prodname_desktop %}.' +intro: 'You can open a pull request branch in {% data variables.product.prodname_desktop %} to view the commit history, run checks, or make changes.' redirect_from: - /desktop/contributing-to-projects/accessing-a-pull-request-locally - /desktop/contributing-and-collaborating-using-github-desktop/accessing-a-pull-request-locally @@ -9,14 +9,21 @@ redirect_from: versions: fpt: '*' --- + ## About pull requests in {% data variables.product.prodname_desktop %} -You can view pull requests that you or your collaborators have proposed in {% data variables.product.prodname_desktop %}. Pull requests let you propose changes to projects, provide feedback and reviews, and merge changes into projects. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -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 "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." +Pull requests let you propose changes to projects, provide feedback and reviews, and merge changes into projects. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." -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 "[AUTOTITLE](/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)." +When someone creates a pull request, they make changes on a "head branch" and suggest these changes to a "base branch," such as `main`. In {% data variables.product.prodname_desktop %}, you can open (or "check out") the head branch of a pull request to view the changes a contributor is suggesting. For example, you can see a history of the commits that the contributor has made, and see which files the commits modified, added, or deleted. + +Checking out the head branch can be useful if you want to make changes to the branch that are too complex for you to leave as suggestions in a review. For example, you might want to make structural changes to some content, add or remove files, or resolve a merge conflict that is too complex to resolve on {% data variables.product.prodname_dotcom %}. From {% data variables.product.prodname_desktop %}, you can view the branch in your preferred editor to view any changes or make additional updates. + +Alternatively, you might just want to view information such as commit history and status checks in an environment you're familiar with, without needing to navigate to the pull request on {% data variables.product.prodname_dotcom %}. 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 "[Working with a pull request in {% data variables.product.prodname_desktop %}](#working-with-a-pull-request-in-github-desktop)." + +You cannot comment on a pull request from {% data variables.product.prodname_desktop %}. After reviewing changes in a pull request, you can give feedback on {% data variables.product.prodname_dotcom %}. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)" and "[Viewing a pull request on {% data variables.product.prodname_dotcom %}](#viewing-a-pull-request-on-github)." + +## Opening a pull request branch in {% data variables.product.prodname_desktop %} -## Viewing a pull request in {% data variables.product.prodname_desktop %} {% data reusables.desktop.current-branch-menu %} {% data reusables.desktop.click-pull-requests %} ![Screenshot of the "Current Branch" dropdown menu. A tab, labeled "Pull Requests", is highlighted with an orange outline.](/assets/images/help/desktop/branch-drop-down-pull-request-tab.png) @@ -26,9 +33,58 @@ If checks have been enabled in your repository, {% data variables.product.prodna ![Screenshot of the "Pull Requests" tab. A button, labeled with an icon of two arrows forming a circle, is highlighted with an orange outline.](/assets/images/help/desktop/pull-request-list-sync.png) -## Opening a pull request in {% data variables.product.prodname_desktop %} from {% data variables.product.prodname_dotcom %} +{% data reusables.desktop.checked-out-pr %} + +## Opening a pull request branch in {% data variables.product.prodname_desktop %} from {% data variables.product.prodname_dotcom %} + {% data reusables.repositories.sidebar-pr %} 2. In the list of pull requests, click the pull request that you would like to open in {% data variables.product.prodname_desktop %}. 3. To the right of the title of the pull request, click **{% octicon "code" aria-label="" %} Code**, then, on the **Local** tab, click **Checkout with GitHub Desktop**. ![Screenshot of a pull request on GitHub. The "Code" dropdown menu is expanded, and a button, labeled "Checkout with GitHub Desktop" is outlined in orange.](/assets/images/help/desktop/open-pr-in-desktop-button.png) + +{% data reusables.desktop.checked-out-pr %} + +## Working with a pull request in {% data variables.product.prodname_desktop %} + +When you have checked out a pull request branch, you can use {% data variables.product.prodname_desktop %} and your local editor to view the contributor's changes or make further changes to the branch. For example, you can: + +- [Open the branch in your editor](#open-the-branch-in-your-editor) +- [View the commit history](#view-the-commit-history) +- [View and re-run checks](#view-and-re-run-checks) + +### Open the branch in your editor + +If you want to look at changes in context or make additional updates to a pull request, you can view the contents of the branch in your local editor. + +1. In the "{% data variables.product.prodname_desktop %}" menu bar, select **Repository**. +1. Click **Open in EDITOR**. + + ![Screenshot of a menu bar on a Mac. Under the open "Repository" dropdown menu, a cursor hovers over "Open in Visual Studio Code", highlighted in blue.](/assets/images/help/desktop/open-in-editor.png) + +For more information, see "[AUTOTITLE](/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor-in-github-desktop)." + +### View the commit history + +You can view the commit history of the branch if you want to see how the contributor arrived at the set of changes they're suggesting. + +{% data reusables.desktop.history-tab %} +1. In "Select Branch to Compare...", search for and select the base branch of the pull request. +1. Click the **Ahead** tab. + + ![Screenshot of the "History" tab. Above a list of commits, "main" is entered as the branch to compare, and a tab labeled "Ahead" is outlined in orange.](/assets/images/help/desktop/ahead-tab.png) + +For more information, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/viewing-the-branch-history-in-github-desktop)." + +### View and re-run checks + +You can view the status of checks that have run against the pull request branch. Failed checks may indicate problems with the proposed changes, which could prevent the branch from merging. You can re-run checks from {% data variables.product.prodname_desktop %}. For more information, see "[AUTOTITLE](/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-and-re-running-checks)." + +## Viewing a pull request on {% data variables.product.prodname_dotcom %} + +To add comments to a pull request, leave a review, or merge the pull request, you will need to navigate to the pull request on {% data variables.product.prodname_dotcom %}. When you have checked out a pull request branch in {% data variables.product.prodname_desktop %}, you can quickly open the corresponding pull request on {% data variables.product.prodname_dotcom %}. + +1. In the {% data variables.product.prodname_desktop %} menu bar, click **Branch**. +1. Select **View Pull Request on {% data variables.product.prodname_dotcom %}**. + + ![Screenshot of the menu bar on a Mac. The "Branch" dropdown menu is expanded, and the cursor hovers over "View Pull Request on {% data variables.product.prodname_dotcom %}".](/assets/images/help/desktop/view-pr-on-github.png) \ No newline at end of file diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md index eb4be78b9e..b7e88729c8 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/viewing-branches-in-your-repository.md @@ -28,3 +28,5 @@ shortTitle: View branches - "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)" - "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)" +{%- ifversion repository-activity-view %} +- "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository)."{% endif %} \ No newline at end of file diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md index a855349d5e..c025b87ecd 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/analyzing-changes-to-a-repositorys-content.md @@ -54,3 +54,8 @@ The code frequency graph displays the content additions and deletions for each w {% data reusables.repositories.accessing-repository-graphs %} 3. In the left sidebar, click **Code frequency**. ![Screenshot of the left sidebar. The "Code frequency" tab is highlighted with a dark orange outline.](/assets/images/help/graphs/code_frequency_tab.png) + +{% ifversion repository-activity-view %} +{% data reusables.repositories.activity-view %} +For more information, see "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository)." +{% endif %} \ No newline at end of file diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/index.md b/content/repositories/viewing-activity-and-data-for-your-repository/index.md index 0eefd3a121..8a1bdd9bbc 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/index.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/index.md @@ -17,11 +17,11 @@ topics: children: - /viewing-deployment-activity-for-your-repository - /about-repository-graphs - - /viewing-a-summary-of-repository-activity + - /using-pulse-to-view-a-summary-of-repository-activity - /viewing-traffic-to-a-repository - /viewing-a-projects-contributors - /analyzing-changes-to-a-repositorys-content - /understanding-connections-between-repositories + - /using-the-activity-view-to-see-changes-to-a-repository shortTitle: View activity and data --- - diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md b/content/repositories/viewing-activity-and-data-for-your-repository/using-pulse-to-view-a-summary-of-repository-activity.md similarity index 61% rename from content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md rename to content/repositories/viewing-activity-and-data-for-your-repository/using-pulse-to-view-a-summary-of-repository-activity.md index c46877c571..ef9ff22d44 100644 --- a/content/repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity.md +++ b/content/repositories/viewing-activity-and-data-for-your-repository/using-pulse-to-view-a-summary-of-repository-activity.md @@ -1,11 +1,12 @@ --- -title: Viewing a summary of repository activity -intro: 'You can view an overview of a repository''s pull request, issue, and commit activity.' +title: Using Pulse to view a summary of repository activity +intro: 'You can use Pulse to see an overview of a repository''s pull request, issue, and commit activity.' product: '{% data reusables.gated-features.repository-insights %}' redirect_from: - /articles/viewing-a-summary-of-repository-activity - /github/visualizing-repository-data-with-graphs/viewing-a-summary-of-repository-activity - /github/visualizing-repository-data-with-graphs/accessing-basic-repository-data/viewing-a-summary-of-repository-activity + - /repositories/viewing-activity-and-data-for-your-repository/viewing-a-summary-of-repository-activity versions: fpt: '*' ghes: '*' @@ -13,7 +14,7 @@ versions: ghec: '*' topics: - Repositories -shortTitle: View repository activity +shortTitle: Using Pulse --- ## About Pulse @@ -22,11 +23,13 @@ You can view an overview of a repository's activity through Pulse. Pulse include Commit co-authors are included in the commit activity summary if their commits were merged into the repository's default branch and they're in the top 15 users who have contributed the most commits. +{% ifversion repository-activity-view %} +{% data reusables.repositories.activity-view %} +For more information, see "[AUTOTITLE](/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository)." +{% endif %} + ## Accessing Pulse {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %} - -## Filtering by time - -By default, Pulse shows the last seven days of repository activity. To choose a different time period, select the **Period** dropdown menu in the upper-right corner of the Pulse overview. +1. Optionally, to choose a different time period, select the **Period** dropdown menu in the upper-right corner of the Pulse overview. By default, Pulse shows the last seven days of repository activity. diff --git a/content/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md b/content/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md new file mode 100644 index 0000000000..a129b81406 --- /dev/null +++ b/content/repositories/viewing-activity-and-data-for-your-repository/using-the-activity-view-to-see-changes-to-a-repository.md @@ -0,0 +1,43 @@ +--- +title: Using the activity view to see changes to a repository +intro: 'You can use the activity view to see a detailed history of changes to your repository.' +versions: + feature: repository-activity-view +topics: + - Repositories +shortTitle: Using the activity view +--- + +## About the activity view + +The activity view lets you see a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and authenticated users. + +You can filter the view to show activity for a particular branch, a particular user, or for a specific period of time. You can also filter by activity type. For example, you can choose to filter by "Force pushes", to see all force pushes to the repository. + +For each activity, you can view the exact changes by clicking "Compare changes." + +## Using the activity view to see changes to a repository +{% data reusables.repositories.navigate-to-repo %} +1. There are two ways to enter the activity view: + - On the main page of the repository, to the right of the list of files, click **{% octicon "pulse" aria-hidden="true" %} Activity**. + + - Alternatively, click **{% octicon "git-branch" aria-hidden="true" %} Branches**, then to the right of any branch, click **{% octicon "pulse" aria-label="View branch activity" %}**. + + ![Screenshot of a repository's branches view. To the right of a branch, the pulse icon is highlighted with a dark orange outline.](/assets/images/help/graphs/activity-view-icon.png) + +1. Use the dropdown menus to filter the activity view. + - To see activity on a particular branch, select the **{% octicon "git-branch" aria-hidden="true" %} BRANCH NAME** dropdown menu, then click a branch name. Alternatively, within the dropdown menu, start typing a branch name into the search field. To view activity across all branches in the repository, click "View activity for all branches". + + - To filter by activity type, select the **{% octicon "pulse" aria-hidden="true" %} All activity** dropdown menu, then click an activity type. You can choose to display direct pushes, pull request merges, force pushes, branch creations, and branch deletions. + + - To filter by user, select the **{% octicon "people" aria-hidden="true" %} All users** dropdown menu, then click a username. Alternatively, within the dropdown menu, start typing a username into the search field. + + - To filter by time, select the **{% octicon "clock" aria-hidden="true" %} All time** dropdown menu, then click a time period. + +1. Optionally, to see some additional details about the activity, such as the incoming branch name from a pull request, hover over the embedded link. + + ![Screenshot of a repository's activity view. A link, embedded in the description of an activity, is highlighted with a dark orange outline.](/assets/images/help/graphs/activity-view-embedded-link.png) + +1. To see exactly what changes were introduced by a particular activity, to the right of the activity, select {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "git-compare" aria-hidden="true" %} Compare changes**. + + ![Screenshot of a repository's activity view. The horizontal kebab icon, and a pop-up button, labeled "Compare changes", are highlighted with a dark orange outline.](/assets/images/help/graphs/activity-view-compare-changes.png) diff --git a/data/features/repository-activity-view.yml b/data/features/repository-activity-view.yml new file mode 100644 index 0000000000..748e031107 --- /dev/null +++ b/data/features/repository-activity-view.yml @@ -0,0 +1,7 @@ +# Reference: Issue #8651 - Repository Activity View + +versions: + fpt: '*' + ghec: '*' + ghes: '> 3.9' + ghae: '> 3.9' diff --git a/data/reusables/desktop/checked-out-pr.md b/data/reusables/desktop/checked-out-pr.md new file mode 100644 index 0000000000..f926005de6 --- /dev/null +++ b/data/reusables/desktop/checked-out-pr.md @@ -0,0 +1 @@ +When you have opened a pull request branch, you can view the contents of the branch in an editor, view the diff and commit history of the contributor's updates, and view and re-run checks. For more information, see "[Working with a pull request in {% data variables.product.prodname_desktop %}](#working-with-a-pull-request-in-github-desktop)." \ No newline at end of file diff --git a/data/reusables/repositories/activity-view.md b/data/reusables/repositories/activity-view.md new file mode 100644 index 0000000000..071b12449f --- /dev/null +++ b/data/reusables/repositories/activity-view.md @@ -0,0 +1 @@ +If you want to see a detailed history of changes to a repository, you can use the activity view. The activity view displays all pushes, merges, force pushes, and branch changes, and associates these changes with commits and authenticated users. \ No newline at end of file