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

remove unnecessary conditionals from content files

Browse Source
This commit is contained in:
Hector Alfaro
2022-05-13 14:32:50 -04:00
parent 6cbe4d131e
commit 08ca047c87
48 changed files with 61 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile.md
View File

@@ -91,10 +91,7 @@ The contribution activity section includes a detailed timeline of your work, inc
![Contribution activity time filter](/assets/images/help/profile/contributions_activity_time_filter.png) ![Contribution activity time filter](/assets/images/help/profile/contributions_activity_time_filter.png)
{% ifversion fpt or ghes or ghae or ghec %}
## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %} ## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %}
If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)." If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)."
{% endif %}

4
content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md
View File

@@ -28,15 +28,11 @@ The security log lists all actions performed within the last 90 days.
![Security log tab](/assets/images/help/settings/audit-log-tab.png) ![Security log tab](/assets/images/help/settings/audit-log-tab.png)
{% endif %} {% endif %}
{% ifversion fpt or ghae or ghes or ghec %}
## Searching your security log ## Searching your security log
{% data reusables.audit_log.audit-log-search %} {% data reusables.audit_log.audit-log-search %}
### Search based on the action performed ### Search based on the action performed
{% else %}
## Understanding events in your security log
{% endif %}
The events listed in your security log are triggered by your actions. Actions are grouped into the following categories: The events listed in your security log are triggered by your actions. Actions are grouped into the following categories:

2
content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md
View File

@@ -36,9 +36,7 @@ Using the template builder, you can specify a title and description for each tem
With issue forms, you can create templates that have web form fields using the {% data variables.product.prodname_dotcom %} form schema. When a contributor opens an issue using an issue form, the form inputs are converted to a standard markdown issue comment. You can specify different input types and set inputs as required to help contributors open actionable issues in your repository. For more information, see "[Configuring issue templates for your repository](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms)" and "[Syntax for issue forms](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)." With issue forms, you can create templates that have web form fields using the {% data variables.product.prodname_dotcom %} form schema. When a contributor opens an issue using an issue form, the form inputs are converted to a standard markdown issue comment. You can specify different input types and set inputs as required to help contributors open actionable issues in your repository. For more information, see "[Configuring issue templates for your repository](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-forms)" and "[Syntax for issue forms](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms)."
{% endif %} {% endif %}
{% ifversion fpt or ghae or ghes or ghec %}
{% data reusables.repositories.issue-template-config %} For more information, see "[Configuring issue templates for your repository](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)." {% data reusables.repositories.issue-template-config %} For more information, see "[Configuring issue templates for your repository](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)."
{% endif %}
Issue templates are stored on the repository's default branch, in a hidden `.github/ISSUE_TEMPLATE` directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a *.md* extension.{% ifversion fpt or ghec %} Issue templates created with issue forms need a *.yml* extension.{% endif %} {% data reusables.repositories.valid-community-issues %} Issue templates are stored on the repository's default branch, in a hidden `.github/ISSUE_TEMPLATE` directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a *.md* extension.{% ifversion fpt or ghec %} Issue templates created with issue forms need a *.yml* extension.{% endif %} {% data reusables.repositories.valid-community-issues %}

6
content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md
View File

@@ -21,12 +21,8 @@ shortTitle: Configure
{% endif %} {% endif %}
{% ifversion fpt or ghae or ghes or ghec %}
## Creating issue templates ## Creating issue templates
{% endif %}
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.sidebar-settings %}
3. In the "Features" section, under "Issues," click **Set up templates**. 3. In the "Features" section, under "Issues," click **Set up templates**.
@@ -71,7 +67,6 @@ Here is the rendered version of the issue form.
{% endif %} {% endif %}
{% ifversion fpt or ghae or ghes or ghec %}
## Configuring the template chooser ## Configuring the template chooser
{% data reusables.repositories.issue-template-config %} {% data reusables.repositories.issue-template-config %}
@@ -110,7 +105,6 @@ Your configuration file will customize the template chooser when the file is mer
{% data reusables.files.write_commit_message %} {% data reusables.files.write_commit_message %}
{% data reusables.files.choose_commit_branch %} {% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_new_file %} {% data reusables.files.propose_new_file %}
{% endif %}
## Further reading ## Further reading

14
content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md
View File

@@ -238,8 +238,8 @@ While most of your API interaction should occur using your server-to-server inst
* [List deployments](/rest/reference/deployments#list-deployments) * [List deployments](/rest/reference/deployments#list-deployments)
* [Create a deployment](/rest/reference/deployments#create-a-deployment) * [Create a deployment](/rest/reference/deployments#create-a-deployment)
* [Get a deployment](/rest/reference/deployments#get-a-deployment){% ifversion fpt or ghes or ghae or ghec %} * [Get a deployment](/rest/reference/deployments#get-a-deployment)
* [Delete a deployment](/rest/reference/deployments#delete-a-deployment){% endif %} * [Delete a deployment](/rest/reference/deployments#delete-a-deployment)
#### Events #### Events
@@ -421,14 +421,12 @@ While most of your API interaction should occur using your server-to-server inst
* [Remove pre-receive hook enforcement for an organization](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) * [Remove pre-receive hook enforcement for an organization](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization)
{% endif %} {% endif %}
{% ifversion fpt or ghes or ghae or ghec %}
#### Organization Team Projects #### Organization Team Projects
* [List team projects](/rest/reference/teams#list-team-projects) * [List team projects](/rest/reference/teams#list-team-projects)
* [Check team permissions for a project](/rest/reference/teams#check-team-permissions-for-a-project) * [Check team permissions for a project](/rest/reference/teams#check-team-permissions-for-a-project)
* [Add or update team project permissions](/rest/reference/teams#add-or-update-team-project-permissions) * [Add or update team project permissions](/rest/reference/teams#add-or-update-team-project-permissions)
* [Remove a project from a team](/rest/reference/teams#remove-a-project-from-a-team) * [Remove a project from a team](/rest/reference/teams#remove-a-project-from-a-team)
{% endif %}
#### Organization Team Repositories #### Organization Team Repositories
@@ -574,7 +572,7 @@ While most of your API interaction should occur using your server-to-server inst
#### Reactions #### Reactions
{% ifversion fpt or ghes or ghae or ghec %}* [Delete a reaction](/rest/reference/reactions#delete-a-reaction-legacy){% else %}* [Delete a reaction](/rest/reference/reactions#delete-a-reaction){% endif %} * [Delete a reaction](/rest/reference/reactions#delete-a-reaction-legacy)
* [List reactions for a commit comment](/rest/reference/reactions#list-reactions-for-a-commit-comment) * [List reactions for a commit comment](/rest/reference/reactions#list-reactions-for-a-commit-comment)
* [Create reaction for a commit comment](/rest/reference/reactions#create-reaction-for-a-commit-comment) * [Create reaction for a commit comment](/rest/reference/reactions#create-reaction-for-a-commit-comment)
* [List reactions for an issue](/rest/reference/reactions#list-reactions-for-an-issue) * [List reactions for an issue](/rest/reference/reactions#list-reactions-for-an-issue)
@@ -586,13 +584,13 @@ While most of your API interaction should occur using your server-to-server inst
* [List reactions for a team discussion comment](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) * [List reactions for a team discussion comment](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment)
* [Create reaction for a team discussion comment](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) * [Create reaction for a team discussion comment](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)
* [List reactions for a team discussion](/rest/reference/reactions#list-reactions-for-a-team-discussion) * [List reactions for a team discussion](/rest/reference/reactions#list-reactions-for-a-team-discussion)
* [Create reaction for a team discussion](/rest/reference/reactions#create-reaction-for-a-team-discussion){% ifversion fpt or ghes or ghae or ghec %} * [Create reaction for a team discussion](/rest/reference/reactions#create-reaction-for-a-team-discussion)
* [Delete a commit comment reaction](/rest/reference/reactions#delete-a-commit-comment-reaction) * [Delete a commit comment reaction](/rest/reference/reactions#delete-a-commit-comment-reaction)
* [Delete an issue reaction](/rest/reference/reactions#delete-an-issue-reaction) * [Delete an issue reaction](/rest/reference/reactions#delete-an-issue-reaction)
* [Delete a reaction to a commit comment](/rest/reference/reactions#delete-an-issue-comment-reaction) * [Delete a reaction to a commit comment](/rest/reference/reactions#delete-an-issue-comment-reaction)
* [Delete a pull request comment reaction](/rest/reference/reactions#delete-a-pull-request-comment-reaction) * [Delete a pull request comment reaction](/rest/reference/reactions#delete-a-pull-request-comment-reaction)
* [Delete team discussion reaction](/rest/reference/reactions#delete-team-discussion-reaction) * [Delete team discussion reaction](/rest/reference/reactions#delete-team-discussion-reaction)
* [Delete team discussion comment reaction](/rest/reference/reactions#delete-team-discussion-comment-reaction){% endif %} * [Delete team discussion comment reaction](/rest/reference/reactions#delete-team-discussion-comment-reaction)
#### Repositories #### Repositories
@@ -706,11 +704,9 @@ While most of your API interaction should occur using your server-to-server inst
* [Get a repository README](/rest/reference/repos#get-a-repository-readme) * [Get a repository README](/rest/reference/repos#get-a-repository-readme)
* [Get the license for a repository](/rest/reference/licenses#get-the-license-for-a-repository) * [Get the license for a repository](/rest/reference/licenses#get-the-license-for-a-repository)
{% ifversion fpt or ghes or ghae or ghec %}
#### Repository Event Dispatches #### Repository Event Dispatches
* [Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event) * [Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)
{% endif %}
#### Repository Hooks #### Repository Hooks

10
content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md
View File

@@ -353,8 +353,8 @@ Webhook events are triggered based on the specificity of the domain you register
### Webhook payload object ### Webhook payload object
Key | Type | Description Key | Type | Description
----|------|-------------{% ifversion fpt or ghes or ghae or ghec %} ----|------|-------------
`action` |`string` | The action performed. Can be `created`.{% endif %} `action` |`string` | The action performed. Can be `created`.
`deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments). `deployment` |`object` | The [deployment](/rest/reference/deployments#list-deployments).
{% data reusables.webhooks.repo_desc %} {% data reusables.webhooks.repo_desc %}
{% data reusables.webhooks.org_desc %} {% data reusables.webhooks.org_desc %}
@@ -378,8 +378,8 @@ Key | Type | Description
### Webhook payload object ### Webhook payload object
Key | Type | Description Key | Type | Description
----|------|-------------{% ifversion fpt or ghes or ghae or ghec %} ----|------|-------------
`action` |`string` | The action performed. Can be `created`.{% endif %} `action` |`string` | The action performed. Can be `created`.
`deployment_status` |`object` | The [deployment status](/rest/reference/deployments#list-deployment-statuses). `deployment_status` |`object` | The [deployment status](/rest/reference/deployments#list-deployment-statuses).
`deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`. `deployment_status["state"]` |`string` | The new state. Can be `pending`, `success`, `failure`, or `error`.
`deployment_status["target_url"]` |`string` | The optional link added to the status. `deployment_status["target_url"]` |`string` | The optional link added to the status.
@@ -1152,7 +1152,6 @@ Key | Type | Description
{{ webhookPayloadsForCurrentVersion.release.published }} {{ webhookPayloadsForCurrentVersion.release.published }}
{% ifversion fpt or ghes or ghae or ghec %}
## repository_dispatch ## repository_dispatch
This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)" endpoint. This event occurs when a {% data variables.product.prodname_github_app %} sends a `POST` request to the "[Create a repository dispatch event](/rest/reference/repos#create-a-repository-dispatch-event)" endpoint.
@@ -1164,7 +1163,6 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
### Webhook payload example ### Webhook payload example
{{ webhookPayloadsForCurrentVersion.repository_dispatch }} {{ webhookPayloadsForCurrentVersion.repository_dispatch }}
{% endif %}
## repository ## repository

4
content/get-started/getting-started-with-git/about-remote-repositories.md
View File

@@ -81,14 +81,10 @@ When you `git clone`, `git fetch`, `git pull`, or `git push` to a remote reposit
{% endtip %} {% endtip %}
{% ifversion fpt or ghes or ghae or ghec %}
## Cloning with {% data variables.product.prodname_cli %} ## Cloning with {% data variables.product.prodname_cli %}
You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.product_name %} workflows in your terminal. For more information, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)." You can also install {% data variables.product.prodname_cli %} to use {% data variables.product.product_name %} workflows in your terminal. For more information, see "[About {% data variables.product.prodname_cli %}](/github-cli/github-cli/about-github-cli)."
{% endif %}
{% ifversion not ghae %} {% ifversion not ghae %}
## Cloning with Subversion ## Cloning with Subversion

3
content/get-started/quickstart/communicating-on-github.md
View File

@@ -116,7 +116,6 @@ This example shows the {% data variables.product.prodname_discussions %} welcome
This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository. This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository.
{% endif %} {% endif %}
{% ifversion fpt or ghes or ghae or ghec %}
### Scenarios for team discussions ### Scenarios for team discussions
- I have a question that's not necessarily related to specific files in the repository. - I have a question that's not necessarily related to specific files in the repository.
@@ -139,8 +138,6 @@ The `octocat` team member posted a team discussion, informing the team of variou
- There is a blog post describing how the teams use {% data variables.product.prodname_actions %} to produce their docs. - There is a blog post describing how the teams use {% data variables.product.prodname_actions %} to produce their docs.
- Material about the April All Hands is now available for all team members to view. - Material about the April All Hands is now available for all team members to view.
{% endif %}
## Next steps ## Next steps
These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs. These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs.

15
content/get-started/using-github/keyboard-shortcuts.md
View File

@@ -30,7 +30,7 @@ The {% data variables.product.prodname_command_palette %} also gives you quick a
| Keyboard shortcut | Description | Keyboard shortcut | Description
|-----------|------------ |-----------|------------
|<kbd>S</kbd> or <kbd>/</kbd> | Focus the search bar. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." |<kbd>S</kbd> or <kbd>/</kbd> | Focus the search bar. For more information, see "[About searching on {% data variables.product.company_short %}](/search-github/getting-started-with-searching-on-github/about-searching-on-github)."
|<kbd>G</kbd> <kbd>N</kbd> | Go to your notifications. For more information, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}." |<kbd>G</kbd> <kbd>N</kbd> | Go to your notifications. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)."
|<kbd>Esc</kbd> | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in |<kbd>Esc</kbd> | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in
{% if command-palette %}|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>K</kbd> or <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd>. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %} {% if command-palette %}|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with <kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>K</kbd> or <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>K</kbd>. For more information, see "[{% data variables.product.prodname_command_palette %}](/get-started/using-github/github-command-palette)."{% endif %}
@@ -101,7 +101,6 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>Command</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>G</kbd> (Windows/Linux) | Insert a suggestion. For more information, see "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." |{% endif %} |<kbd>Command</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>G</kbd> (Windows/Linux) | Insert a suggestion. For more information, see "[Reviewing proposed changes in a pull request](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." |{% endif %}
|<kbd>R</kbd> | Quote the selected text in your reply. For more information, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax#quoting-text)." | |<kbd>R</kbd> | Quote the selected text in your reply. For more information, see "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax#quoting-text)." |
## Issue and pull request lists ## Issue and pull request lists
| Keyboard shortcut | Description | Keyboard shortcut | Description
@@ -137,8 +136,8 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>J</kbd> | Move selection down in the list |<kbd>J</kbd> | Move selection down in the list
|<kbd>K</kbd> | Move selection up in the list |<kbd>K</kbd> | Move selection up in the list
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> | Add a single comment on a pull request diff | |<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> | Add a single comment on a pull request diff |
|<kbd>Alt</kbd> and click | Toggle between collapsing and expanding all outdated review comments in a pull request by holding down <kbd>Alt</kbd> and clicking **Show outdated** or **Hide outdated**.|{% ifversion fpt or ghes or ghae or ghec %} |<kbd>Alt</kbd> and click | Toggle between collapsing and expanding all outdated review comments in a pull request by holding down <kbd>Alt</kbd> and clicking **Show outdated** or **Hide outdated**.|
|Click, then <kbd>Shift</kbd> and click | Comment on multiple lines of a pull request by clicking a line number, holding <kbd>Shift</kbd>, then clicking another line number. For more information, see "[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)."|{% endif %} |Click, then <kbd>Shift</kbd> and click | Comment on multiple lines of a pull request by clicking a line number, holding <kbd>Shift</kbd>, then clicking another line number. For more information, see "[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)."|
## Project boards ## Project boards
@@ -195,7 +194,6 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
## Notifications ## Notifications
{% ifversion fpt or ghes or ghae or ghec %}
| Keyboard shortcut | Description | Keyboard shortcut | Description
|-----------|------------ |-----------|------------
|<kbd>E</kbd> | Mark as done |<kbd>E</kbd> | Mark as done
@@ -203,13 +201,6 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|<kbd>Shift</kbd>+<kbd>I</kbd>| Mark as read |<kbd>Shift</kbd>+<kbd>I</kbd>| Mark as read
|<kbd>Shift</kbd>+<kbd>M</kbd> | Unsubscribe |<kbd>Shift</kbd>+<kbd>M</kbd> | Unsubscribe
{% else %}
| Keyboard shortcut | Description
|-----------|------------
|<kbd>E</kbd> or <kbd>I</kbd> or <kbd>Y</kbd> | Mark as read
|<kbd>Shift</kbd>+<kbd>M</kbd> | Mute thread
{% endif %}
## Network graph ## Network graph

2
content/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists.md
View File

@@ -60,7 +60,6 @@ Gist supports mapping GeoJSON files. These maps are displayed in embedded gists,
Follow the steps below to create a gist. Follow the steps below to create a gist.
{% ifversion fpt or ghes or ghae or ghec %}
{% note %} {% note %}
You can also create a gist using the {% data variables.product.prodname_cli %}. For more information, see "[`gh gist create`](https://cli.github.com/manual/gh_gist_create)" in the {% data variables.product.prodname_cli %} documentation. You can also create a gist using the {% data variables.product.prodname_cli %}. For more information, see "[`gh gist create`](https://cli.github.com/manual/gh_gist_create)" in the {% data variables.product.prodname_cli %} documentation.
@@ -68,7 +67,6 @@ You can also create a gist using the {% data variables.product.prodname_cli %}.
Alternatively, you can drag and drop a text file from your desktop directly into the editor. Alternatively, you can drag and drop a text file from your desktop directly into the editor.
{% endnote %} {% endnote %}
{% endif %}
1. Sign in to {% data variables.product.product_name %}. 1. Sign in to {% data variables.product.product_name %}.
2. Navigate to your {% data variables.gists.gist_homepage %}. 2. Navigate to your {% data variables.gists.gist_homepage %}.

3
content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
View File

@@ -28,7 +28,6 @@ When you use two or more headings, GitHub automatically generates a table of con
![Screenshot highlighting the table of contents icon](/assets/images/help/repository/headings_toc.png) ![Screenshot highlighting the table of contents icon](/assets/images/help/repository/headings_toc.png)
## Styling text ## Styling text
You can indicate emphasis with bold, italic, or strikethrough text in comment fields and `.md` files. You can indicate emphasis with bold, italic, or strikethrough text in comment fields and `.md` files.
@@ -234,7 +233,7 @@ For more information, see "[About task lists](/articles/about-task-lists)."
## Mentioning people and teams ## Mentioning people and teams
You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing <kbd>@</kbd> plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}." You can mention a person or [team](/articles/setting-up-teams/) on {% data variables.product.product_name %} by typing <kbd>@</kbd> plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)."
{% note %} {% note %}

2
content/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests.md
View File

@@ -15,7 +15,7 @@ topics:
## Linking a pull request to an issue ## Linking a pull request to an issue
To link a pull request to an issue to{% ifversion fpt or ghes or ghae or ghec %} show that a fix is in progress and to{% endif %} automatically close the issue when someone merges the pull request, type one of the following keywords followed by a reference to the issue. For example, `Closes #10` or `Fixes octo-org/octo-repo#100`. To link a pull request to an issue to show that a fix is in progress and to automatically close the issue when someone merges the pull request, type one of the following keywords followed by a reference to the issue. For example, `Closes #10` or `Fixes octo-org/octo-repo#100`.
* close * close
* closes * closes

4
content/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/filtering-cards-on-a-project-board.md
View File

@@ -29,8 +29,8 @@ You can also use the "Filter cards" search bar at the top of each project board
- Filter by check status using `status:pending`, `status:success`, or `status:failure` - Filter by check status using `status:pending`, `status:success`, or `status:failure`
- Filter cards by type using `type:issue`, `type:pr`, or `type:note` - Filter cards by type using `type:issue`, `type:pr`, or `type:note`
- Filter cards by state and type using `is:open`, `is:closed`, or `is:merged`; and `is:issue`, `is:pr`, or `is:note` - Filter cards by state and type using `is:open`, `is:closed`, or `is:merged`; and `is:issue`, `is:pr`, or `is:note`
- Filter cards by issues that are linked to a pull request by a closing reference using `linked:pr`{% ifversion fpt or ghes or ghae or ghec %} - Filter cards by issues that are linked to a pull request by a closing reference using `linked:pr`
- Filter cards by repository in an organization-wide project board using `repo:ORGANIZATION/REPOSITORY`{% endif %} - Filter cards by repository in an organization-wide project board using `repo:ORGANIZATION/REPOSITORY`
1. Navigate to the project board that contains the cards you want to filter. 1. Navigate to the project board that contains the cards you want to filter.
2. Above the project card columns, click into the "Filter cards" search bar and type a search query to filter the cards. 2. Above the project card columns, click into the "Filter cards" search bar and type a search query to filter the cards.

2
content/issues/tracking-your-work-with-issues/about-issues.md
View File

@@ -35,7 +35,7 @@ For more information about projects, see {% ifversion fpt or ghec %}"[About proj
## Stay up to date ## Stay up to date
To stay updated on the most recent comments in an issue, you can subscribe to an issue to receive notifications about the latest comments. To quickly find links to recently updated issues you're subscribed to, visit your dashboard. For more information, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[About notifications](/github/receiving-notifications-about-activity-on-github/about-notifications){% endif %}" and "[About your personal dashboard](/articles/about-your-personal-dashboard)." To stay updated on the most recent comments in an issue, you can subscribe to an issue to receive notifications about the latest comments. To quickly find links to recently updated issues you're subscribed to, visit your dashboard. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" and "[About your personal dashboard](/articles/about-your-personal-dashboard)."
## Community management ## Community management

7
content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md
View File

@@ -178,11 +178,9 @@ With issue and pull request search terms, you can:
{% endtip %} {% endtip %}
{% endif %} {% endif %}
{% ifversion fpt or ghes or ghae or ghec %}
For issues, you can also use search to: For issues, you can also use search to:
- Filter for issues that are linked to a pull request by a closing reference: `linked:pr` - Filter for issues that are linked to a pull request by a closing reference: `linked:pr`
{% endif %}
For pull requests, you can also use search to: For pull requests, you can also use search to:
- Filter [draft](/articles/about-pull-requests#draft-pull-requests) pull requests: `is:draft` - Filter [draft](/articles/about-pull-requests#draft-pull-requests) pull requests: `is:draft`
@@ -193,8 +191,8 @@ For pull requests, you can also use search to:
- Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat` - Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat`
- Filter pull requests by the specific user [requested for review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat`{% ifversion fpt or ghae-issue-5181 or ghes > 3.2 or ghec %} - Filter pull requests by the specific user [requested for review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat`{% ifversion fpt or ghae-issue-5181 or ghes > 3.2 or ghec %}
- Filter pull requests that someone has asked you directly to review: `state:open type:pr user-review-requested:@me`{% endif %} - Filter pull requests that someone has asked you directly to review: `state:open type:pr user-review-requested:@me`{% endif %}
- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom`{% ifversion fpt or ghes or ghae or ghec %} - Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom`
- Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`{% endif %} - Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue`
## Sorting issues and pull requests ## Sorting issues and pull requests
@@ -217,7 +215,6 @@ You can sort any filtered view by:
To clear your sort selection, click **Sort** > **Newest**. To clear your sort selection, click **Sort** > **Newest**.
## Sharing filters ## Sharing filters
When you filter or sort issues and pull requests, your browser's URL is automatically updated to match the new view. When you filter or sort issues and pull requests, your browser's URL is automatically updated to match the new view.

6
content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md
View File

@@ -26,7 +26,7 @@ shortTitle: Link PR to issue
## About linked issues and pull requests ## About linked issues and pull requests
You can link an issue to a pull request {% ifversion fpt or ghes or ghae or ghec %}manually or {% endif %}using a supported keyword in the pull request description. You can link an issue to a pull request manually or using a supported keyword in the pull request description.
When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue. When you link a pull request to the issue the pull request addresses, collaborators can see that someone is working on the issue.
@@ -56,11 +56,10 @@ Issue in the same repository | *KEYWORD* #*ISSUE-NUMBER* | `Closes #10`
Issue in a different repository | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100` Issue in a different repository | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100`
Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100` Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100`
{% ifversion fpt or ghes or ghae or ghec %}Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword.{% endif %} Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword.
You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch, but the pull request that contains the commit will not be listed as a linked pull request. You can also use closing keywords in a commit message. The issue will be closed when you merge the commit into the default branch, but the pull request that contains the commit will not be listed as a linked pull request.
{% ifversion fpt or ghes or ghae or ghec %}
## Manually linking a pull request to an issue ## Manually linking a pull request to an issue
Anyone with write permissions to a repository can manually link a pull request to an issue. Anyone with write permissions to a repository can manually link a pull request to an issue.
@@ -78,7 +77,6 @@ You can manually link up to ten issues to each pull request. The issue and pull
{% endif %} {% endif %}
5. Click the issue you want to link to the pull request. 5. Click the issue you want to link to the pull request.
![Drop down to link issue](/assets/images/help/pull_requests/link-issue-drop-down.png) ![Drop down to link issue](/assets/images/help/pull_requests/link-issue-drop-down.png)
{% endif %}
## Further reading ## Further reading

2
content/issues/tracking-your-work-with-issues/viewing-all-of-your-issues-and-pull-requests.md
View File

@@ -26,4 +26,4 @@ Your issues and pull request dashboards are available at the top of any page. On
## Further reading ## Further reading
- {% ifversion fpt or ghes or ghae or ghec %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions#reviewing-repositories-that-youre-watching){% else %}"[Listing the repositories you're watching](/github/receiving-notifications-about-activity-on-github/listing-the-repositories-youre-watching){% endif %}" - "[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions#reviewing-repositories-that-youre-watching)"

2
content/organizations/collaborating-with-groups-in-organizations/about-your-organization-dashboard.md
View File

@@ -35,7 +35,7 @@ In the left sidebar of your dashboard, you can access your organization's top re
In the "All activity" section of your news feed, you can view updates from other teams and repositories in your organization. In the "All activity" section of your news feed, you can view updates from other teams and repositories in your organization.
The "All activity" section shows all recent activity in the organization, including activity in repositories you're not subscribed to and of people you're not following. For more information, see {% ifversion fpt or ghes or ghae or ghec %}"[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications){% else %}"[Watching and unwatching repositories](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-repositories){% endif %}" and "[Following people](/articles/following-people)." The "All activity" section shows all recent activity in the organization, including activity in repositories you're not subscribed to and of people you're not following. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" and "[Following people](/articles/following-people)."
For instance, the organization news feed shows updates when someone in the organization: For instance, the organization news feed shows updates when someone in the organization:
- Creates a new branch. - Creates a new branch.

4
content/organizations/collaborating-with-your-team/about-team-discussions.md
View File

@@ -32,7 +32,7 @@ When someone posts or replies to a public discussion on a team's page, members o
{% tip %} {% tip %}
**Tip:** Depending on your notification settings, you'll receive updates by email, the web notifications page on {% data variables.product.product_name %}, or both. For more information, see {% ifversion fpt or ghae or ghes or ghec %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications)" and "[About web notifications](/github/receiving-notifications-about-activity-on-github/about-web-notifications){% endif %}." **Tip:** Depending on your notification settings, you'll receive updates by email, the web notifications page on {% data variables.product.product_name %}, or both. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)."
{% endtip %} {% endtip %}
@@ -40,7 +40,7 @@ By default, if your username is mentioned in a team discussion, you'll receive n
To turn off notifications for team discussions, you can unsubscribe to a specific discussion post or change your notification settings to unwatch or completely ignore a specific team's discussions. You can subscribe to notifications for a specific discussion post even if you're unwatching that team's discussions. To turn off notifications for team discussions, you can unsubscribe to a specific discussion post or change your notification settings to unwatch or completely ignore a specific team's discussions. You can subscribe to notifications for a specific discussion post even if you're unwatching that team's discussions.
For more information, see {% ifversion fpt or ghae or ghes or ghec %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Subscribing to and unsubscribing from notifications](/github/receiving-notifications-about-activity-on-github/subscribing-to-and-unsubscribing-from-notifications){% endif %}" and "[Nested teams](/articles/about-teams/#nested-teams)." For more information, see "[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions)" and "[Nested teams](/articles/about-teams/#nested-teams)."
{% ifversion fpt or ghec %} {% ifversion fpt or ghec %}

10
content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization.md
View File

@@ -61,8 +61,8 @@ To search for specific events, use the `action` qualifier in your query. Actions
| [`members_can_create_pages`](#members_can_create_pages-category-actions) | Contains all activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." | {% endif %} | [`members_can_create_pages`](#members_can_create_pages-category-actions) | Contains all activities related to managing the publication of {% data variables.product.prodname_pages %} sites for repositories in the organization. For more information, see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)." | {% endif %}
| [`org`](#org-category-actions) | Contains activities related to organization membership.{% ifversion ghec %} | [`org`](#org-category-actions) | Contains activities related to organization membership.{% ifversion ghec %}
| [`org_credential_authorization`](#org_credential_authorization-category-actions) | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if secret-scanning-audit-log-custom-patterns %} | [`org_credential_authorization`](#org_credential_authorization-category-actions) | Contains all activities related to authorizing credentials for use with SAML single sign-on.{% endif %}{% if secret-scanning-audit-log-custom-patterns %}
| [`org_secret_scanning_custom_pattern`](#org_secret_scanning_custom_pattern-category-actions) | Contains organization-level activities related to secret scanning custom patterns. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %}{% ifversion fpt or ghes or ghae or ghec %} | [`org_secret_scanning_custom_pattern`](#org_secret_scanning_custom_pattern-category-actions) | Contains organization-level activities related to secret scanning custom patterns. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." {% endif %}
| [`organization_label`](#organization_label-category-actions) | Contains all activities related to default labels for repositories in your organization.{% endif %} | [`organization_label`](#organization_label-category-actions) | Contains all activities related to default labels for repositories in your organization.
| [`oauth_application`](#oauth_application-category-actions) | Contains all activities related to OAuth Apps. | [`oauth_application`](#oauth_application-category-actions) | Contains all activities related to OAuth Apps.
| [`packages`](#packages-category-actions) | Contains all activities related to {% data variables.product.prodname_registry %}.{% ifversion fpt or ghec %} | [`packages`](#packages-category-actions) | Contains all activities related to {% data variables.product.prodname_registry %}.{% ifversion fpt or ghec %}
| [`payment_method`](#payment_method-category-actions) | Contains all activities related to how your organization pays for GitHub.{% endif %} | [`payment_method`](#payment_method-category-actions) | Contains all activities related to how your organization pays for GitHub.{% endif %}
@@ -497,7 +497,6 @@ For more information, see "[Managing the publication of {% data variables.produc
| `delete` | Triggered when a custom pattern is removed from secret scanning in an organization. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern)." | `delete` | Triggered when a custom pattern is removed from secret scanning in an organization. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning#removing-a-custom-pattern)."
{% endif %} {% endif %}
{% ifversion fpt or ghes or ghae or ghec %}
### `organization_label` category actions ### `organization_label` category actions
| Action | Description | Action | Description
@@ -506,8 +505,6 @@ For more information, see "[Managing the publication of {% data variables.produc
| `update` | Triggered when a default label is edited. | `update` | Triggered when a default label is edited.
| `destroy` | Triggered when a default label is deleted. | `destroy` | Triggered when a default label is deleted.
{% endif %}
### `oauth_application` category actions ### `oauth_application` category actions
| Action | Description | Action | Description
@@ -572,11 +569,10 @@ For more information, see "[Managing the publication of {% data variables.produc
| `update_required_status_checks_enforcement_level ` | Triggered when enforcement of required status checks is updated on a branch. | `update_required_status_checks_enforcement_level ` | Triggered when enforcement of required status checks is updated on a branch.
| `update_strict_required_status_checks_policy` | Triggered when the requirement for a branch to be up to date before merging is changed. | `update_strict_required_status_checks_policy` | Triggered when the requirement for a branch to be up to date before merging is changed.
| `rejected_ref_update ` | Triggered when a branch update attempt is rejected. | `rejected_ref_update ` | Triggered when a branch update attempt is rejected.
| `policy_override ` | Triggered when a branch protection requirement is overridden by a repository administrator.{% ifversion fpt or ghes or ghae or ghec %} | `policy_override ` | Triggered when a branch protection requirement is overridden by a repository administrator.
| `update_allow_force_pushes_enforcement_level ` | Triggered when force pushes are enabled or disabled for a protected branch. | `update_allow_force_pushes_enforcement_level ` | Triggered when force pushes are enabled or disabled for a protected branch.
| `update_allow_deletions_enforcement_level ` | Triggered when branch deletion is enabled or disabled for a protected branch. | `update_allow_deletions_enforcement_level ` | Triggered when branch deletion is enabled or disabled for a protected branch.
| `update_linear_history_requirement_enforcement_level ` | Triggered when required linear commit history is enabled or disabled for a protected branch. | `update_linear_history_requirement_enforcement_level ` | Triggered when required linear commit history is enabled or disabled for a protected branch.
{% endif %}
{% ifversion fpt or ghes > 3.1 or ghae or ghec %} {% ifversion fpt or ghes > 3.1 or ghae or ghec %}

5
content/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member.md
View File

@@ -31,11 +31,10 @@ People with the team maintainer role can manage team membership and settings.
- [Delete team discussions](/articles/managing-disruptive-comments/#deleting-a-comment) - [Delete team discussions](/articles/managing-disruptive-comments/#deleting-a-comment)
- [Add organization members to the team](/articles/adding-organization-members-to-a-team) - [Add organization members to the team](/articles/adding-organization-members-to-a-team)
- [Remove organization members from the team](/articles/removing-organization-members-from-a-team) - [Remove organization members from the team](/articles/removing-organization-members-from-a-team)
- Remove the team's access to repositories{% ifversion fpt or ghes or ghae or ghec %} - Remove the team's access to repositories
- [Manage code review assignment for the team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team){% endif %}{% ifversion fpt or ghec %} - [Manage code review assignment for the team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team){% ifversion fpt or ghec %}
- [Manage scheduled reminders for pull requests](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team){% endif %} - [Manage scheduled reminders for pull requests](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team){% endif %}
## Promoting an organization member to team maintainer ## Promoting an organization member to team maintainer
Before you can promote an organization member to team maintainer, the person must already be a member of the team. Before you can promote an organization member to team maintainer, the person must already be a member of the team.

8
content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request.md
View File

@@ -1,6 +1,6 @@
--- ---
title: Changing the stage of a pull request title: Changing the stage of a pull request
intro: 'You can mark a draft pull request as ready for review{% ifversion fpt or ghae or ghes or ghec %} or convert a pull request to a draft{% endif %}.' intro: You can mark a draft pull request as ready for review or convert a pull request to a draft.
permissions: People with write permissions to a repository and pull request authors can change the stage of a pull request. permissions: People with write permissions to a repository and pull request authors can change the stage of a pull request.
product: '{% data reusables.gated-features.draft-prs %}' product: '{% data reusables.gated-features.draft-prs %}'
redirect_from: redirect_from:
@@ -21,21 +21,17 @@ shortTitle: Change the state
{% data reusables.pull_requests.mark-ready-review %} {% data reusables.pull_requests.mark-ready-review %}
{% ifversion fpt or ghae or ghes or ghec %}
{% tip %} {% tip %}
**Tip**: You can also mark a pull request as ready for review using the {% data variables.product.prodname_cli %}. For more information, see "[`gh pr ready`](https://cli.github.com/manual/gh_pr_ready)" in the {% data variables.product.prodname_cli %} documentation. **Tip**: You can also mark a pull request as ready for review using the {% data variables.product.prodname_cli %}. For more information, see "[`gh pr ready`](https://cli.github.com/manual/gh_pr_ready)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %} {% endtip %}
{% endif %}
{% data reusables.repositories.sidebar-pr %} {% data reusables.repositories.sidebar-pr %}
2. In the "Pull requests" list, click the pull request you'd like to mark as ready for review. 2. In the "Pull requests" list, click the pull request you'd like to mark as ready for review.
3. In the merge box, click **Ready for review**. 3. In the merge box, click **Ready for review**.
![Ready for review button](/assets/images/help/pull_requests/ready-for-review-button.png) ![Ready for review button](/assets/images/help/pull_requests/ready-for-review-button.png)
{% ifversion fpt or ghae or ghes or ghec %}
## Converting a pull request to a draft ## Converting a pull request to a draft
You can convert a pull request to a draft at any time. For example, if you accidentally opened a pull request instead of a draft, or if you've received feedback on your pull request that needs to be addressed, you can convert the pull request to a draft to indicate further changes are needed. No one can merge the pull request until you mark the pull request as ready for review again. People who are already subscribed to notifications for the pull request will not be unsubscribed when you convert the pull request to a draft. You can convert a pull request to a draft at any time. For example, if you accidentally opened a pull request instead of a draft, or if you've received feedback on your pull request that needs to be addressed, you can convert the pull request to a draft to indicate further changes are needed. No one can merge the pull request until you mark the pull request as ready for review again. People who are already subscribed to notifications for the pull request will not be unsubscribed when you convert the pull request to a draft.
@@ -47,8 +43,6 @@ You can convert a pull request to a draft at any time. For example, if you accid
4. Click **Convert to draft**. 4. Click **Convert to draft**.
![Convert to draft confirmation](/assets/images/help/pull_requests/convert-to-draft-dialog.png) ![Convert to draft confirmation](/assets/images/help/pull_requests/convert-to-draft-dialog.png)
{% endif %}
## Further reading ## Further reading
- "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)" - "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests)"

2
content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review.md
View File

@@ -21,7 +21,7 @@ Repositories belong to a personal account (a single individual owner) or an orga
To assign a reviewer to a pull request, you will need write access to the repository. For more information about repository access, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." If you have write access, you can assign anyone who has read access to the repository as a reviewer. To assign a reviewer to a pull request, you will need write access to the repository. For more information about repository access, see "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)." If you have write access, you can assign anyone who has read access to the repository as a reviewer.
Organization members with write access can also assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. {% ifversion fpt or ghae or ghes or ghec %}If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review settings for your team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)."{% endif %} Organization members with write access can also assign a pull request review to any person or team with read access to a repository. The requested reviewer or team will receive a notification that you asked them to review the pull request. If you request a review from a team and code review assignment is enabled, specific members will be requested and the team will be removed as a reviewer. For more information, see "[Managing code review settings for your team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)."
{% note %} {% note %}

2
content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md
View File

@@ -21,7 +21,7 @@ After a pull request is opened, anyone with *read* access can review and comment
{% if pull-request-approval-limit %}{% data reusables.pull_requests.code-review-limits %}{% endif %} {% if pull-request-approval-limit %}{% data reusables.pull_requests.code-review-limits %}{% endif %}
Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." {% ifversion fpt or ghae or ghes or ghec %}You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review settings for your team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)."{% endif %} Repository owners and collaborators can request a pull request review from a specific person. Organization members can also request a pull request review from a team with read access to the repository. For more information, see "[Requesting a pull request review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." You can specify a subset of team members to be automatically assigned in the place of the whole team. For more information, see "[Managing code review settings for your team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)."
Reviews allow for discussion of proposed changes and help ensure that the changes meet the repository's contributing guidelines and other quality standards. You can define which individuals or teams own certain types or areas of code in a CODEOWNERS file. When a pull request modifies code that has a defined owner, that individual or team will automatically be requested as a reviewer. For more information, see "[About code owners](/articles/about-code-owners/)." Reviews allow for discussion of proposed changes and help ensure that the changes meet the repository's contributing guidelines and other quality standards. You can define which individuals or teams own certain types or areas of code in a CODEOWNERS file. When a pull request modifies code that has a defined owner, that individual or team will automatically be requested as a reviewer. For more information, see "[About code owners](/articles/about-code-owners/)."

6
content/pull-requests/committing-changes-to-your-project/viewing-and-comparing-commits/comparing-commits.md
View File

@@ -30,10 +30,10 @@ Here's an example of a [comparison between two branches](https://github.com/octo
## Comparing tags ## Comparing tags
Comparing release tags will show you changes to your repository since the last release. {% ifversion fpt or ghae or ghes or ghec %} Comparing release tags will show you changes to your repository since the last release.
For more information, see "[Comparing releases](/github/administering-a-repository/comparing-releases)."{% endif %} For more information, see "[Comparing releases](/github/administering-a-repository/comparing-releases)."
{% ifversion fpt or ghae or ghes or ghec %}To compare tags, you can select a tag name from the `compare` drop-down menu at the top of the page.{% else %} Instead of typing a branch name, type the name of your tag in the `compare` drop down menu.{% endif %} To compare tags, you can select a tag name from the `compare` drop-down menu at the top of the page.
Here's an example of a [comparison between two tags](https://github.com/octocat/linguist/compare/v2.2.0...octocat:v2.3.3). Here's an example of a [comparison between two tags](https://github.com/octocat/linguist/compare/v2.2.0...octocat:v2.3.3).

3
content/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github.md
View File

@@ -26,8 +26,7 @@ shortTitle: About merge methods
{% data reusables.pull_requests.default_merge_option %} {% data reusables.pull_requests.default_merge_option %}
{% ifversion fpt or ghae or ghes or ghec %} The default merge method creates a merge commit. You can prevent anyone from pushing merge commits to a protected branch by enforcing a linear commit history. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-linear-history)."
The default merge method creates a merge commit. You can prevent anyone from pushing merge commits to a protected branch by enforcing a linear commit history. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-linear-history)."{% endif %}
## Squashing your merge commits ## Squashing your merge commits

3
content/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/troubleshooting-required-status-checks.md
View File

@@ -36,14 +36,11 @@ remote: error: Required status check "ci-build" is failing
{% endnote %} {% endnote %}
{% ifversion fpt or ghae or ghes or ghec %}
## Conflicts between head commit and test merge commit ## Conflicts between head commit and test merge commit
Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, the test merge commit must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pulls](/rest/reference/pulls#get-a-pull-request)." Sometimes, the results of the status checks for the test merge commit and head commit will conflict. If the test merge commit has a status, the test merge commit must pass. Otherwise, the status of the head commit must pass before you can merge the branch. For more information about test merge commits, see "[Pulls](/rest/reference/pulls#get-a-pull-request)."
![Branch with conflicting merge commits](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png) ![Branch with conflicting merge commits](/assets/images/help/repository/req-status-check-conflicting-merge-commits.png)
{% endif %}
## Handling skipped but required checks ## Handling skipped but required checks

6
content/repositories/creating-and-managing-repositories/creating-a-new-repository.md
View File

@@ -25,19 +25,17 @@ topics:
{% endtip %} {% endtip %}
{% ifversion fpt or ghae or ghes or ghec %}
{% tip %} {% tip %}
**Tip**: You can also create a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation. **Tip**: You can also create a repository using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %} {% endtip %}
{% endif %}
{% data reusables.repositories.create_new %} {% data reusables.repositories.create_new %}
2. Optionally, to create a repository with the directory structure and files of an existing repository, use the **Choose a template** drop-down and select a template repository. You'll see template repositories that are owned by you and organizations you're a member of or that you've used before. For more information, see "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)." 2. Optionally, to create a repository with the directory structure and files of an existing repository, use the **Choose a template** drop-down and select a template repository. You'll see template repositories that are owned by you and organizations you're a member of or that you've used before. For more information, see "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)."
![Template drop-down menu](/assets/images/help/repository/template-drop-down.png){% ifversion fpt or ghae or ghes or ghec %} ![Template drop-down menu](/assets/images/help/repository/template-drop-down.png)
3. Optionally, if you chose to use a template, to include the directory structure and files from all branches in the template, and not just the default branch, select **Include all branches**. 3. Optionally, if you chose to use a template, to include the directory structure and files from all branches in the template, and not just the default branch, select **Include all branches**.
![Include all branches checkbox](/assets/images/help/repository/include-all-branches.png){% endif %} ![Include all branches checkbox](/assets/images/help/repository/include-all-branches.png)
3. In the Owner drop-down, select the account you wish to create the repository on. 3. In the Owner drop-down, select the account you wish to create the repository on.
![Owner drop-down menu](/assets/images/help/repository/create-repository-owner.png) ![Owner drop-down menu](/assets/images/help/repository/create-repository-owner.png)
{% data reusables.repositories.repo-name %} {% data reusables.repositories.repo-name %}

8
content/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template.md
View File

@@ -18,17 +18,13 @@ shortTitle: Create from a template
Anyone with read permissions to a template repository can create a repository from that template. For more information, see "[Creating a template repository](/articles/creating-a-template-repository)." Anyone with read permissions to a template repository can create a repository from that template. For more information, see "[Creating a template repository](/articles/creating-a-template-repository)."
{% ifversion fpt or ghae or ghes or ghec %}
{% tip %} {% tip %}
**Tip**: You can also create a repository from a template using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation. **Tip**: You can also create a repository from a template using the {% data variables.product.prodname_cli %}. For more information, see "[`gh repo create`](https://cli.github.com/manual/gh_repo_create)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %} {% endtip %}
{% endif %}
{% ifversion fpt or ghae or ghes or ghec %}
You can choose to include the directory structure and files from only the default branch of the template repository or to include all branches. Branches created from a template have unrelated histories, which means you cannot create pull requests or merge between the branches. You can choose to include the directory structure and files from only the default branch of the template repository or to include all branches. Branches created from a template have unrelated histories, which means you cannot create pull requests or merge between the branches.
{% endif %}
Creating a repository from a template is similar to forking a repository, but there are important differences: Creating a repository from a template is similar to forking a repository, but there are important differences:
- A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit. - A new fork includes the entire commit history of the parent repository, while a repository created from a template starts with a single commit.
@@ -44,8 +40,8 @@ For more information about forks, see "[About forks](/pull-requests/collaboratin
![Use this template button](/assets/images/help/repository/use-this-template-button.png) ![Use this template button](/assets/images/help/repository/use-this-template-button.png)
{% data reusables.repositories.owner-drop-down %} {% data reusables.repositories.owner-drop-down %}
{% data reusables.repositories.repo-name %} {% data reusables.repositories.repo-name %}
{% data reusables.repositories.choose-repo-visibility %}{% ifversion fpt or ghae or ghes or ghec %} {% data reusables.repositories.choose-repo-visibility %}
6. Optionally, to include the directory structure and files from all branches in the template, and not just the default branch, select **Include all branches**. 6. Optionally, to include the directory structure and files from all branches in the template, and not just the default branch, select **Include all branches**.
![Include all branches checkbox](/assets/images/help/repository/include-all-branches.png){% endif %} ![Include all branches checkbox](/assets/images/help/repository/include-all-branches.png)
{% data reusables.repositories.select-marketplace-apps %} {% data reusables.repositories.select-marketplace-apps %}
8. Click **Create repository from template**. 8. Click **Create repository from template**.

4
content/repositories/creating-and-managing-repositories/creating-a-template-repository.md
View File

@@ -1,6 +1,6 @@
--- ---
title: Creating a template repository title: Creating a template repository
intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure{% ifversion fpt or ghae or ghes or ghec %}, branches,{% endif %} and files.' intro: 'You can make an existing repository a template, so you and others can generate new repositories with the same directory structure, branches, and files.'
permissions: Anyone with admin permissions to a repository can make the repository a template. permissions: Anyone with admin permissions to a repository can make the repository a template.
redirect_from: redirect_from:
- /articles/creating-a-template-repository - /articles/creating-a-template-repository
@@ -23,7 +23,7 @@ shortTitle: Create a template repo
To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)." To create a template repository, you must create a repository, then make the repository a template. For more information about creating a repository, see "[Creating a new repository](/articles/creating-a-new-repository)."
After you make your repository a template, anyone with access to the repository can generate a new repository with the same directory structure and files as your default branch.{% ifversion fpt or ghae or ghes or ghec %} They can also choose to include all the other branches in your repository. Branches created from a template have unrelated histories, so you cannot create pull requests or merge between the branches.{% endif %} For more information, see "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)." After you make your repository a template, anyone with access to the repository can generate a new repository with the same directory structure and files as your default branch. They can also choose to include all the other branches in your repository. Branches created from a template have unrelated histories, so you cannot create pull requests or merge between the branches. For more information, see "[Creating a repository from a template](/articles/creating-a-repository-from-a-template)."
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.sidebar-settings %}

9
content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/about-email-notifications-for-pushes-to-your-repository.md
View File

@@ -30,7 +30,7 @@ Each email notification for a push to a repository lists the new commits and lin
- The files that were changed as part of the commit - The files that were changed as part of the commit
- The commit message - The commit message
You can filter email notifications you receive for pushes to a repository. For more information, see {% ifversion fpt or ghae or ghes or ghec %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications){% else %}"[About notification emails](/github/receiving-notifications-about-activity-on-github/about-email-notifications)." You can also turn off email notifications for pushes. For more information, see "[Choosing the delivery method for your notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications){% endif %}." You can filter email notifications you receive for pushes to a repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)."
## Enabling email notifications for pushes to your repository ## Enabling email notifications for pushes to your repository
@@ -45,10 +45,5 @@ You can filter email notifications you receive for pushes to a repository. For m
![Setup notifications button](/assets/images/help/settings/setup_notifications_settings.png) ![Setup notifications button](/assets/images/help/settings/setup_notifications_settings.png)
## Further reading ## Further reading
{% ifversion fpt or ghae or ghes or ghec %}
- "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)" - "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications)"
{% else %}
- "[About notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-notifications)"
- "[Choosing the delivery method for your notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications)"
- "[About email notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-email-notifications)"
- "[About web notifications](/enterprise/{{ currentVersion }}/user/github/receiving-notifications-about-activity-on-github/about-web-notifications)"{% endif %}

2
content/repositories/releasing-projects-on-github/about-releases.md
View File

@@ -31,7 +31,7 @@ Releases are deployable software iterations you can package and make available f
Releases are based on [Git tags](https://git-scm.com/book/en/Git-Basics-Tagging), which mark a specific point in your repository's history. A tag date may be different than a release date since they can be created at different times. For more information about viewing your existing tags, see "[Viewing your repository's releases and tags](/github/administering-a-repository/viewing-your-repositorys-releases-and-tags)." Releases are based on [Git tags](https://git-scm.com/book/en/Git-Basics-Tagging), which mark a specific point in your repository's history. A tag date may be different than a release date since they can be created at different times. For more information about viewing your existing tags, see "[Viewing your repository's releases and tags](/github/administering-a-repository/viewing-your-repositorys-releases-and-tags)."
You can receive notifications when new releases are published in a repository without receiving notifications about other updates to the repository. For more information, see {% ifversion fpt or ghae or ghes or ghec %}"[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions){% else %}"[Watching and unwatching releases for a repository](/github/receiving-notifications-about-activity-on-github/watching-and-unwatching-releases-for-a-repository){% endif %}." You can receive notifications when new releases are published in a repository without receiving notifications about other updates to the repository. For more information, see "[Viewing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions)."
Anyone with read access to a repository can view and compare releases, but only people with write permissions to a repository can manage releases. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)." Anyone with read access to a repository can view and compare releases, but only people with write permissions to a repository can manage releases. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)."

2
content/repositories/releasing-projects-on-github/viewing-your-repositorys-releases-and-tags.md
View File

@@ -16,13 +16,11 @@ topics:
- Repositories - Repositories
shortTitle: View releases & tags shortTitle: View releases & tags
--- ---
{% ifversion fpt or ghae or ghes or ghec %}
{% tip %} {% tip %}
**Tip**: You can also view a release using the {% data variables.product.prodname_cli %}. For more information, see "[`gh release view`](https://cli.github.com/manual/gh_release_view)" in the {% data variables.product.prodname_cli %} documentation. **Tip**: You can also view a release using the {% data variables.product.prodname_cli %}. For more information, see "[`gh release view`](https://cli.github.com/manual/gh_release_view)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %} {% endtip %}
{% endif %}
## Viewing releases ## Viewing releases

2
content/rest/guides/getting-started-with-the-checks-api.md
View File

@@ -41,9 +41,7 @@ A check run is an individual test that is part of a check suite. Each run includ
![Check runs workflow](/assets/images/check_runs.png) ![Check runs workflow](/assets/images/check_runs.png)
{% ifversion fpt or ghes or ghae or ghec %}
If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters). If a check run is in a incomplete state for more than 14 days, then the check run's `conclusion` becomes `stale` and appears on {% data variables.product.prodname_dotcom %} as stale with {% octicon "issue-reopened" aria-label="The issue-reopened icon" %}. Only {% data variables.product.prodname_dotcom %} can mark check runs as `stale`. For more information about possible conclusions of a check run, see the [`conclusion` parameter](/rest/reference/checks#create-a-check-run--parameters).
{% endif %}
As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed. As soon as you receive the [`check_suite`](/webhooks/event-payloads/#check_suite) webhook, you can create the check run, even if the check is not complete. You can update the `status` of the check run as it completes with the values `queued`, `in_progress`, or `completed`, and you can update the `output` as more details become available. A check run can contain timestamps, a link to more details on your external site, detailed annotations for specific lines of code, and information about the analysis performed.

2
content/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax.md
View File

@@ -86,7 +86,6 @@ If your search query contains whitespace, you will need to surround it with quot
Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected. Some non-alphanumeric symbols, such as spaces, are dropped from code search queries within quotation marks, so results can be unexpected.
{% ifversion fpt or ghes or ghae or ghec %}
## Queries with usernames ## Queries with usernames
If your search query contains a qualifier that requires a username, such as `user`, `actor`, or `assignee`, you can use any {% data variables.product.product_name %} username, to specify a specific person, or `@me`, to specify the current user. If your search query contains a qualifier that requires a username, such as `user`, `actor`, or `assignee`, you can use any {% data variables.product.product_name %} username, to specify a specific person, or `@me`, to specify the current user.
@@ -97,4 +96,3 @@ Query | Example
`QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) matches issues assigned to the person viewing the results `QUALIFIER:@me` | [`is:issue assignee:@me`](https://github.com/search?q=is%3Aissue+assignee%3A%40me&type=Issues) matches issues assigned to the person viewing the results
You can only use `@me` with a qualifier and not as search term, such as `@me main.workflow`. You can only use `@me` with a qualifier and not as search term, such as `@me main.workflow`.
{% endif %}

11
content/search-github/searching-on-github/searching-issues-and-pull-requests.md
View File

@@ -54,15 +54,12 @@ To search issues and pull requests in all repositories owned by a certain user o
{% data reusables.pull_requests.large-search-workaround %} {% data reusables.pull_requests.large-search-workaround %}
| Qualifier | Example | Qualifier | Example
| ------------- | ------------- | ------------- | -------------
| <code>user:<em>USERNAME</em></code> | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) matches issues with the word "ubuntu" from repositories owned by @defunkt. | <code>user:<em>USERNAME</em></code> | [**user:defunkt ubuntu**](https://github.com/search?q=user%3Adefunkt+ubuntu&type=Issues) matches issues with the word "ubuntu" from repositories owned by @defunkt.
| <code>org:<em>ORGNAME</em></code> | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) matches issues in repositories owned by the GitHub organization. | <code>org:<em>ORGNAME</em></code> | [**org:github**](https://github.com/search?q=org%3Agithub&type=Issues&utf8=%E2%9C%93) matches issues in repositories owned by the GitHub organization.
| <code>repo:<em>USERNAME/REPOSITORY</em></code> | [**repo:mozilla/shumway created:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) matches issues from @mozilla's shumway project that were created before March 2012. | <code>repo:<em>USERNAME/REPOSITORY</em></code> | [**repo:mozilla/shumway created:<2012-03-01**](https://github.com/search?q=repo%3Amozilla%2Fshumway+created%3A%3C2012-03-01&type=Issues) matches issues from @mozilla's shumway project that were created before March 2012.
## Search by open or closed state ## Search by open or closed state
You can filter issues and pull requests based on whether they're open or closed using the `state` or `is` qualifier. You can filter issues and pull requests based on whether they're open or closed using the `state` or `is` qualifier.
@@ -136,7 +133,6 @@ You can use the `involves` qualifier to find issues that in some way involve a c
| <code>involves:<em>USERNAME</em></code> | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** matches issues either @defunkt or @jlord are involved in. | <code>involves:<em>USERNAME</em></code> | **[involves:defunkt involves:jlord](https://github.com/search?q=involves%3Adefunkt+involves%3Ajlord&type=Issues)** matches issues either @defunkt or @jlord are involved in.
| | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) matches issues @mdo is involved in that do not contain the word "bootstrap" in the body. | | [**NOT bootstrap in:body involves:mdo**](https://github.com/search?q=NOT+bootstrap+in%3Abody+involves%3Amdo&type=Issues) matches issues @mdo is involved in that do not contain the word "bootstrap" in the body.
{% ifversion fpt or ghes or ghae or ghec %}
## Search for linked issues and pull requests ## Search for linked issues and pull requests
You can narrow your results to only include issues that are linked to a pull request by a closing reference, or pull requests that are linked to an issue that the pull request may close. You can narrow your results to only include issues that are linked to a pull request by a closing reference, or pull requests that are linked to an issue that the pull request may close.
@@ -145,7 +141,7 @@ You can narrow your results to only include issues that are linked to a pull req
| `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) matches open issues in the `desktop/desktop` repository that are linked to a pull request by a closing reference. | | `linked:pr` | [**repo:desktop/desktop is:open linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+linked%3Apr) matches open issues in the `desktop/desktop` repository that are linked to a pull request by a closing reference. |
| `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) matches closed pull requests in the `desktop/desktop` repository that were linked to an issue that the pull request may have closed. | | `linked:issue` | [**repo:desktop/desktop is:closed linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aclosed+linked%3Aissue) matches closed pull requests in the `desktop/desktop` repository that were linked to an issue that the pull request may have closed. |
| `-linked:pr` | [**repo:desktop/desktop is:open -linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) matches open issues in the `desktop/desktop` repository that are not linked to a pull request by a closing reference. | | `-linked:pr` | [**repo:desktop/desktop is:open -linked:pr**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Apr) matches open issues in the `desktop/desktop` repository that are not linked to a pull request by a closing reference. |
| `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) matches open pull requests in the `desktop/desktop` repository that are not linked to an issue that the pull request may close. |{% endif %} | `-linked:issue` | [**repo:desktop/desktop is:open -linked:issue**](https://github.com/search?q=repo%3Adesktop%2Fdesktop+is%3Aopen+-linked%3Aissue) matches open pull requests in the `desktop/desktop` repository that are not linked to an issue that the pull request may close. |
## Search by label ## Search by label
@@ -243,10 +239,9 @@ You can filter issues and pull requests by the number of reactions using the `re
You can filter for draft pull requests. For more information, see "[About pull requests](/articles/about-pull-requests#draft-pull-requests)." You can filter for draft pull requests. For more information, see "[About pull requests](/articles/about-pull-requests#draft-pull-requests)."
| Qualifier | Example | Qualifier | Example
| ------------- | -------------{% ifversion fpt or ghes or ghae or ghec %} | ------------- | -------------
| `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests. | `draft:true` | [**draft:true**](https://github.com/search?q=draft%3Atrue) matches draft pull requests.
| `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) matches pull requests that are ready for review.{% else %} | `draft:false` | [**draft:false**](https://github.com/search?q=draft%3Afalse) matches pull requests that are ready for review.
| `is:draft` | [**is:draft**](https://github.com/search?q=is%3Adraft) matches draft pull requests.{% endif %}
## Search by pull request review status and reviewer ## Search by pull request review status and reviewer

2
data/reusables/apps/deprecating_auth_with_query_parameters.md
View File

@@ -1,4 +1,3 @@
{% ifversion fpt or ghes or ghae or ghec %}
{% warning %} {% warning %}
**Deprecation Notice:** {% data variables.product.prodname_dotcom %} will discontinue authentication to the API using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens).{% ifversion fpt or ghec %} Using query parameters to authenticate to the API will no longer work on May 5, 2021. {% endif %} For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/). **Deprecation Notice:** {% data variables.product.prodname_dotcom %} will discontinue authentication to the API using query parameters. Authenticating to the API should be done with [HTTP basic authentication](/rest/overview/other-authentication-methods#via-oauth-and-personal-access-tokens).{% ifversion fpt or ghec %} Using query parameters to authenticate to the API will no longer work on May 5, 2021. {% endif %} For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/).
@@ -6,4 +5,3 @@
{% ifversion ghes or ghae %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %} {% ifversion ghes or ghae %} Authentication to the API using query parameters while available is no longer supported due to security concerns. Instead we recommend integrators move their access token, `client_id`, or `client_secret` in the header. {% data variables.product.prodname_dotcom %} will announce the removal of authentication by query parameters with advanced notice. {% endif %}
{% endwarning %} {% endwarning %}
{% endif %}

2
data/reusables/cli/filter-issues-and-pull-requests-tip.md
View File

@@ -1,7 +1,5 @@
{% ifversion fpt or ghes or ghae or ghec %}
{% tip %} {% tip %}
**Tip**: You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation. **Tip**: You can also filter issues or pull requests using the {% data variables.product.prodname_cli %}. For more information, see "[`gh issue list`](https://cli.github.com/manual/gh_issue_list)" or "[`gh pr list`](https://cli.github.com/manual/gh_pr_list)" in the {% data variables.product.prodname_cli %} documentation.
{% endtip %} {% endtip %}
{% endif %}

4
data/reusables/organizations/team_maintainers_can.md
View File

@@ -10,6 +10,6 @@ Members with team maintainer permissions can:
- [Add organization members to the team](/articles/adding-organization-members-to-a-team) - [Add organization members to the team](/articles/adding-organization-members-to-a-team)
- [Remove organization members from the team](/articles/removing-organization-members-from-a-team) - [Remove organization members from the team](/articles/removing-organization-members-from-a-team)
- [Promote an existing team member to team maintainer](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member) - [Promote an existing team member to team maintainer](/organizations/organizing-members-into-teams/assigning-the-team-maintainer-role-to-a-team-member)
- Remove the team's access to repositories{% ifversion fpt or ghes or ghae or ghec %} - Remove the team's access to repositories
- [Manage code review settings for the team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team){% endif %}{% ifversion fpt or ghec %} - [Manage code review settings for the team](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team){% ifversion fpt or ghec %}
- [Manage scheduled reminders for pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests){% endif %} - [Manage scheduled reminders for pull requests](/github/setting-up-and-managing-organizations-and-teams/managing-scheduled-reminders-for-pull-requests){% endif %}

2
data/reusables/pull_requests/close-issues-using-keywords.md
View File

@@ -1 +1 @@
You can link a pull request to an issue to{% ifversion fpt or ghes or ghae or ghec %} show that a fix is in progress and to{% endif %} automatically close the issue when someone merges the pull request. For more information, see "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)." You can link a pull request to an issue to show that a fix is in progress and to automatically close the issue when someone merges the pull request. For more information, see "[Linking a pull request to an issue](/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue)."

4
data/reusables/repositories/copy-clone-url.md
View File

@@ -2,5 +2,5 @@
!["Code" button](/assets/images/help/repository/code-button.png) !["Code" button](/assets/images/help/repository/code-button.png)
1. To clone the repository using HTTPS, under "Clone with HTTPS", click {% octicon "clippy" aria-label="The clipboard icon" %}. To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click **Use SSH**, then click {% octicon "clippy" aria-label="The clipboard icon" %}. To clone a repository using {% data variables.product.prodname_cli %}, click **Use {% data variables.product.prodname_cli %}**, then click {% octicon "clippy" aria-label="The clipboard icon" %}. 1. To clone the repository using HTTPS, under "Clone with HTTPS", click {% octicon "clippy" aria-label="The clipboard icon" %}. To clone the repository using an SSH key, including a certificate issued by your organization's SSH certificate authority, click **Use SSH**, then click {% octicon "clippy" aria-label="The clipboard icon" %}. To clone a repository using {% data variables.product.prodname_cli %}, click **Use {% data variables.product.prodname_cli %}**, then click {% octicon "clippy" aria-label="The clipboard icon" %}.
![The clipboard icon for copying the URL to clone a repository](/assets/images/help/repository/https-url-clone.png) ![The clipboard icon for copying the URL to clone a repository](/assets/images/help/repository/https-url-clone.png)
{% ifversion fpt or ghes or ghae or ghec %}
![The clipboard icon for copying the URL to clone a repository with GitHub CLI](/assets/images/help/repository/https-url-clone-cli.png){% endif %} ![The clipboard icon for copying the URL to clone a repository with GitHub CLI](/assets/images/help/repository/https-url-clone-cli.png)

3
data/reusables/repositories/default-issue-templates.md
View File

@@ -1,2 +1 @@
You can create default issue templates{% ifversion fpt or ghes or ghae or ghec %} and a default configuration file for issue templates{% endif %} for your organization{% ifversion fpt or ghes or ghae or ghec %} or personal account{% endif %}. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." You can create default issue templates and a default configuration file for issue templates for your organization or personal account. For more information, see "[Creating a default community health file](/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)."

2
data/reusables/repositories/squash-and-rebase-linear-commit-hisitory.md
View File

@@ -1 +1 @@
{% ifversion fpt or ghes or ghae or ghec %}If there is a protected branch rule in your repository that requires a linear commit history, you must allow squash merging, rebase merging, or both. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)."{% endif %} If there is a protected branch rule in your repository that requires a linear commit history, you must allow squash merging, rebase merging, or both. For more information, see "[About protected branches](/github/administering-a-repository/about-protected-branches#require-pull-request-reviews-before-merging)."

2
data/reusables/repositories/start-line-comment.md
View File

@@ -1,2 +1,2 @@
1. Hover over the line of code where you'd like to add a comment, and click the blue comment icon.{% ifversion fpt or ghes or ghae or ghec %} To add a comment on multiple lines, click and drag to select the range of lines, then click the blue comment icon.{% endif %} 1. Hover over the line of code where you'd like to add a comment, and click the blue comment icon. To add a comment on multiple lines, click and drag to select the range of lines, then click the blue comment icon.
![Blue comment icon](/assets/images/help/commits/hover-comment-icon.gif) ![Blue comment icon](/assets/images/help/commits/hover-comment-icon.gif)

2
data/reusables/repositories/suggest-changes.md
View File

@@ -1,2 +1,2 @@
1. Optionally, to suggest a specific change to the line{% ifversion fpt or ghes or ghae or ghec %} or lines{% endif %}, click {% octicon "diff" aria-label="The diff symbol" %}, then edit the text within the suggestion block. 1. Optionally, to suggest a specific change to the line or lines, click {% octicon "diff" aria-label="The diff symbol" %}, then edit the text within the suggestion block.
![Suggestion block](/assets/images/help/pull_requests/suggestion-block.png) ![Suggestion block](/assets/images/help/pull_requests/suggestion-block.png)

2
data/reusables/webhooks/check_run_properties.md
View File

@@ -3,7 +3,7 @@ Key | Type | Description
`action`|`string` | The action performed. Can be one of: <ul><li> `created` - A new check run was created.</li><li> `completed` - The `status` of the check run is `completed`.</li><li> `rerequested` - Someone requested to re-run your check run from the pull request UI. See "[About status checks](/articles/about-status-checks#checks)" for more details about the GitHub UI. When you receive a `rerequested` action, you'll need to [create a new check run](/rest/reference/checks#create-a-check-run). Only the {% data variables.product.prodname_github_app %} that someone requests to re-run the check will receive the `rerequested` payload.</li><li> `requested_action` - Someone requested an action your app provides to be taken. Only the {% data variables.product.prodname_github_app %} someone requests to perform an action will receive the `requested_action` payload. To learn more about check runs and requested actions, see "[Check runs and requested actions](/rest/reference/checks#check-runs-and-requested-actions)."</li></ul> `action`|`string` | The action performed. Can be one of: <ul><li> `created` - A new check run was created.</li><li> `completed` - The `status` of the check run is `completed`.</li><li> `rerequested` - Someone requested to re-run your check run from the pull request UI. See "[About status checks](/articles/about-status-checks#checks)" for more details about the GitHub UI. When you receive a `rerequested` action, you'll need to [create a new check run](/rest/reference/checks#create-a-check-run). Only the {% data variables.product.prodname_github_app %} that someone requests to re-run the check will receive the `rerequested` payload.</li><li> `requested_action` - Someone requested an action your app provides to be taken. Only the {% data variables.product.prodname_github_app %} someone requests to perform an action will receive the `requested_action` payload. To learn more about check runs and requested actions, see "[Check runs and requested actions](/rest/reference/checks#check-runs-and-requested-actions)."</li></ul>
`check_run`|`object` | The [check_run](/rest/reference/checks#get-a-check-run). `check_run`|`object` | The [check_run](/rest/reference/checks#get-a-check-run).
`check_run[status]`|`string` | The current status of the check run. Can be `queued`, `in_progress`, or `completed`. `check_run[status]`|`string` | The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
`check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% ifversion fpt or ghes or ghae or ghec %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`. `check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.
`check_run[name]`|`string` | The name of the check run. `check_run[name]`|`string` | The name of the check run.
`check_run[check_suite][id]`|`integer` | The id of the check suite that this check run is part of. `check_run[check_suite][id]`|`integer` | The id of the check suite that this check run is part of.
`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.<br/><br/>**Note:**<ul><li>The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.</li><li>When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.</li></ul> `check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.<br/><br/>**Note:**<ul><li>The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.</li><li>When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.</li></ul>

2
data/reusables/webhooks/check_suite_properties.md
View File

@@ -5,6 +5,6 @@ Key | Type | Description
`check_suite[head_branch]`|`string` | The head branch name the changes are on. `check_suite[head_branch]`|`string` | The head branch name the changes are on.
`check_suite[head_sha]`|`string` | The SHA of the most recent commit for this check suite. `check_suite[head_sha]`|`string` | The SHA of the most recent commit for this check suite.
`check_suite[status]`|`string` | The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. `check_suite[status]`|`string` | The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
`check_suite[conclusion]`|`string`| The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% ifversion fpt or ghes or ghae or ghec %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`. `check_suite[conclusion]`|`string`| The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.
`check_suite[url]`|`string` | URL that points to the check suite API resource. `check_suite[url]`|`string` | URL that points to the check suite API resource.
`check_suite[pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.<br/><br/>**Note:**<ul><li>The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.</li><li>When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.</li></ul> `check_suite[pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_branch`.<br/><br/>**Note:**<ul><li>The `head_sha` of the check suite can differ from the `sha` of the pull request if subsequent pushes are made into the PR.</li><li>When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.</li></ul>

2
data/reusables/webhooks/installation_properties.md
View File

@@ -1,4 +1,4 @@
Key | Type | Description Key | Type | Description
----|------|------------ ----|------|------------
`action` | `string` | The action that was performed. Can be one of:<ul><li>`created` - Someone installs a {% data variables.product.prodname_github_app %}.</li><li>`deleted` - Someone uninstalls a {% data variables.product.prodname_github_app %}</li>{% ifversion fpt or ghes or ghae or ghec %}<li>`suspend` - Someone suspends a {% data variables.product.prodname_github_app %} installation.</li><li>`unsuspend` - Someone unsuspends a {% data variables.product.prodname_github_app %} installation.</li>{% endif %}<li>`new_permissions_accepted` - Someone accepts new permissions for a {% data variables.product.prodname_github_app %} installation. When a {% data variables.product.prodname_github_app %} owner requests new permissions, the person who installed the {% data variables.product.prodname_github_app %} must accept the new permissions request. </li></ul> `action` | `string` | The action that was performed. Can be one of:<ul><li>`created` - Someone installs a {% data variables.product.prodname_github_app %}.</li><li>`deleted` - Someone uninstalls a {% data variables.product.prodname_github_app %}</li><li>`suspend` - Someone suspends a {% data variables.product.prodname_github_app %} installation.</li><li>`unsuspend` - Someone unsuspends a {% data variables.product.prodname_github_app %} installation.</li><li>`new_permissions_accepted` - Someone accepts new permissions for a {% data variables.product.prodname_github_app %} installation. When a {% data variables.product.prodname_github_app %} owner requests new permissions, the person who installed the {% data variables.product.prodname_github_app %} must accept the new permissions request. </li></ul>
`repositories` | `array` | An array of repository objects that the installation can access. `repositories` | `array` | An array of repository objects that the installation can access.