зеркало из https://github.com/github/docs.git
Update Markdown table syntax (#52090)
Co-authored-by: Vanessa <vgrl@github.com>
This commit is contained in:
Rachael Sewell
GitHub
Родитель
28b070d81f
Коммит
c8c4ea23cf
|
|
@ -74,17 +74,20 @@ Additional data is transmitted if you enable individual features of {% data vari
|
|||
| Feature | Data | Which way does the data flow? | Where is the data used? |
|
||||
| ------- | ---- | --------- | ------ |
|
||||
| {% ifversion ghes %} |
|
||||
Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses{% ifversion ghas-in-license-sync %}, and whether the user consumes a license for {% data variables.product.prodname_GH_advanced_security %}{% endif %} | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |
|
||||
| Automatic user license sync | Each {% data variables.product.product_name %} user's user ID and email addresses{% ifversion ghas-in-license-sync %}, and whether the user consumes a license for {% data variables.product.prodname_GH_advanced_security %}{% endif %} | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
{% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |
|
||||
| {% data variables.product.prodname_dependabot_alerts %} | Vulnerability alerts | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |
|
||||
| {% endif %} |
|
||||
| {% ifversion dependabot-updates-github-connect %} |
|
||||
{% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository<br><br>If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} {% endif %}
|
||||
{% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %}{% ifversion server-statistics %}
|
||||
{% data variables.product.prodname_server_statistics %} | Aggregate metrics about your usage of {% data variables.product.prodname_ghe_server %}. For the complete list of metrics, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
||||
Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} |
|
||||
Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} |
|
||||
| {% data variables.product.prodname_dependabot_updates %} | Dependencies and the metadata for each dependency's repository<br><br>If a dependency is stored in a private repository on {% data variables.product.prodname_dotcom_the_website %}, data will only be transmitted if {% data variables.product.prodname_dependabot %} is configured and authorized to access that repository. | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %} | {% data variables.product.product_name %} |
|
||||
| {% endif %} |
|
||||
| {% data variables.product.prodname_dotcom_the_website %} actions | Name of action, action (YAML file from {% data variables.product.prodname_marketplace %}) | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} |
|
||||
| {% ifversion server-statistics %} |
|
||||
| {% data variables.product.prodname_server_statistics %} | Aggregate metrics about your usage of {% data variables.product.prodname_ghe_server %}. For the complete list of metrics, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/analyzing-how-your-team-works-with-server-statistics/about-server-statistics#server-statistics-data-collected)." | From {% data variables.product.product_name %} to {% data variables.product.prodname_ghe_cloud %} | {% data variables.product.prodname_ghe_cloud %} |
|
||||
| {% endif %} |
|
||||
| Unified search | Search terms, search results | From {% data variables.product.prodname_dotcom_the_website %} to {% data variables.product.product_name %}<br><br>From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.product_name %} |
|
||||
| Unified contributions | Contribution counts | From {% data variables.product.product_name %} to {% data variables.product.prodname_dotcom_the_website %} | {% data variables.product.prodname_dotcom_the_website %} |
|
||||
|
||||
## Further reading
|
||||
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when
|
|||
| <pre>releases delete button</pre> | Deletion of a release | "[AUTOTITLE](/repositories/releasing-projects-on-github/managing-releases-in-a-repository#deleting-a-release)" |
|
||||
| <pre>stafftools branch restore</pre> | Restoration of a branch from the site admin dashboard | "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/site-admin-dashboard#repositories)" |
|
||||
| <pre>tag create api</pre> | Creation of a tag via the API | "[AUTOTITLE](/rest/git/tags#create-a-tag-object)" |
|
||||
{%- ifversion ghes < 3.13 %}
|
||||
| {% ifversion ghes < 3.13 %} |
|
||||
| <pre>slumlord (#SHA)</pre> | Commit via Subversion | "[AUTOTITLE](/get-started/working-with-subversion-on-github/support-for-subversion-clients#making-commits-to-subversion)" |
|
||||
| {% endif %} |
|
||||
| <pre>web branch create</pre> | Creation of a branch via the web interface | "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)" |
|
||||
|
|
|
|||
|
|
@ -52,120 +52,122 @@ After you enable {% data variables.product.prodname_server_statistics %}, metric
|
|||
|
||||
The following aggregate metrics will be collected and transmitted on a daily basis and represent the total counts for the day.
|
||||
|
||||
CSV column | Name | Description |
|
||||
---------- | ---- | ----------- |
|
||||
A | `github_connect.features_enabled` | Array of {% data variables.product.prodname_github_connect %} features that are enabled for your instance (see "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features)" ) |
|
||||
B | `host_name` | The hostname for your instance |
|
||||
C | `dormant_users.dormancy_threshold` | The length of time a user must be inactive to be considered dormant |
|
||||
D | `dormant_users.total_dormant_users` | Number of dormant user accounts |
|
||||
E | `ghes_version` | The version of {% data variables.product.product_name %} that your instance is running |
|
||||
F | `server_id` | The UUID generated for your instance
|
||||
G | `collection_date` | The date the metrics were collected |
|
||||
H | `schema_version` | The version of the database schema used to store this data |
|
||||
I | `ghe_stats.comments.total_commit_comments` | Number of comments on commits |
|
||||
J | `ghe_stats.comments.total_gist_comments` | Number of comments on gists |
|
||||
K | `ghe_stats.comments.total_issue_comments` | Number of comments on issues |
|
||||
L | `ghe_stats.comments.total_pull_request_comments` | Number of comments on pull requests |
|
||||
M | `ghe_stats.gists.total_gists` | Number of gists (both secret and public) |
|
||||
N | `ghe_stats.gists.private_gists` | Number of secret gists |
|
||||
O | `ghe_stats.gists.public_gists` | Number of public gists |
|
||||
P | `ghe_stats.hooks.total_hooks` | Number of pre-receive hooks (both active and inactive) |
|
||||
Q | `ghe_stats.hooks.active_hooks` | Number of active pre-receive hooks |
|
||||
R | `ghe_stats.hooks.inactive_hooks` | Number of inactive pre-receive hooks |
|
||||
S | `ghe_stats.issues.total_issues` | Number of issues (both open and closed) |
|
||||
T | `ghe_stats.issues.open_issues` | Number of open issues |
|
||||
U | `ghe_stats.issues.closed_issues` | Number of closed issues |
|
||||
V | `ghe_stats.milestones.total_milestones` | Number of milestones (both open and closed) |
|
||||
W | `ghe_stats.milestones.open_milestones` | Number of open milestones |
|
||||
X | `ghe_stats.milestones.closed_milestones` | Number of closed milestones |
|
||||
Y | `ghe_stats.orgs.total_orgs` | Number of organizations (both enabled and disabled) |
|
||||
Z | `ghe_stats.orgs.disabled_orgs` | Number of disabled organizations |
|
||||
AA | `ghe_stats.orgs.total_teams` | Number of teams |
|
||||
AB | `ghe_stats.orgs.total_team_members` | Number of team members |
|
||||
AC | `ghe_stats.pages.total_pages` | Number of {% data variables.product.prodname_pages %} sites |
|
||||
AD | `ghe_stats.pulls.total_pulls` | Number of pull requests |
|
||||
AE | `ghe_stats.pulls.merged_pulls` | Number of merged pull requests |
|
||||
AF | `ghe_stats.pulls.mergeable_pulls` | Number of pull requests that are currently mergeable |
|
||||
AG | `ghe_stats.pulls.unmergeable_pulls` | Number of pull requests that are currently unmergeable |
|
||||
AH | `ghe_stats.repos.total_repos` | Number of repositories (both upstream repositories and forks) |
|
||||
AI | `ghe_stats.repos.root_repos` | Number of upstream repositories |
|
||||
AJ | `ghe_stats.repos.fork_repos` | Number of forks |
|
||||
AK | `ghe_stats.repos.org_repos` | Number of repositories owned by organizations |
|
||||
AL | `ghe_stats.repos.total_pushes` | Number of pushes to repositories |
|
||||
AM | `ghe_stats.repos.total_wikis` | Number of wikis |
|
||||
AN | `ghe_stats.users.total_users` | Number of user accounts |
|
||||
AO | `ghe_stats.users.admin_users` | Number of user accounts that are site administrators |
|
||||
AP | `ghe_stats.users.suspended_users` | Number of user accounts that are suspended |{% ifversion actions-server-statistics %}
|
||||
AQ | `actions_stats.number_of_repos_using_actions` | Number of repositories using {% data variables.product.prodname_actions %}
|
||||
AR | `actions_stats.percentage_of_repos_using_actions` | Percentage of repositories using {% data variables.product.prodname_actions %}
|
||||
AS | `packages_stats.registry_enabled` | Whether {% data variables.product.prodname_registry %} with repository-scoped packages is enabled for {% data variables.location.product_location %}
|
||||
AT | `packages_stats.registry_v2_enabled` | Whether {% data variables.product.prodname_registry %} with granular permissions is enabled for {% data variables.location.product_location %}
|
||||
AU | `packages_stats.ecosystems.docker.registry_enabled` | Whether Docker is enabled for {% data variables.product.prodname_registry %}
|
||||
AV | `packages_stats.ecosystems.docker.published_packages_count` | Number of published Docker images (private, public, and internal)
|
||||
AW | `packages_stats.ecosystems.docker.private_packages_count`| Number of private Docker images
|
||||
AX | `packages_stats.ecosystems.docker.public_packages_count` | Number of public Docker images
|
||||
AY | `packages_stats.ecosystems.docker.internal_packages_count` | Number of internal Docker images
|
||||
AZ | `packages_stats.ecosystems.docker.user_packages_count` | Number of Docker images owned by users
|
||||
BA | `packages_stats.ecosystems.docker.organization_packages_count` | Number of Docker images owned by organizations
|
||||
BB | `packages_stats.ecosystems.docker.daily_download_count` | Number of downloads of Docker images
|
||||
BC | `packages_stats.ecosystems.docker.daily_update_count` | Number of Docker images updated
|
||||
BD | `packages_stats.ecosystems.docker.daily_delete_count` | Number of Docker images deleted
|
||||
BE | `packages_stats.ecosystems.docker.daily_create_count` | Number of Docker images created
|
||||
BF | `packages_stats.ecosystems.maven.registry_enabled` | Whether Maven is enabled for {% data variables.product.prodname_registry %}
|
||||
BG | `packages_stats.ecosystems.maven.published_packages_count` | Number of published Maven packages (private, public, and internal)
|
||||
BH | `packages_stats.ecosystems.maven.private_packages_count` | Number of private Maven packages
|
||||
BI | `packages_stats.ecosystems.maven.public_packages_count` | Number of public Maven packages
|
||||
BJ | `packages_stats.ecosystems.maven.internal_packages_count` | Number of internal Maven packages
|
||||
BK | `packages_stats.ecosystems.maven.user_packages_count` | Number of Maven packages owned by user accounts
|
||||
BL | `packages_stats.ecosystems.maven.organization_packages_count` | Number of Maven packages owned by organizations
|
||||
BM | `packages_stats.ecosystems.maven.daily_download_count` | Number of downloads of Maven packages
|
||||
BN | `packages_stats.ecosystems.maven.daily_update_count` | Number of Maven packages updated
|
||||
BO | `packages_stats.ecosystems.maven.daily_delete_count` | Number of Maven packages deleted
|
||||
BP | `packages_stats.ecosystems.maven.daily_create_count` | Number of Maven packages created
|
||||
BQ | `packages_stats.ecosystems.npm.registry_enabled` | Whether npm is enabled for {% data variables.product.prodname_registry %}
|
||||
BR | `packages_stats.ecosystems.npm.published_packages_count` | Number of published npm packages (private, public, and internal)
|
||||
BS | `packages_stats.ecosystems.npm.private_packages_count` | Number of private npm packages
|
||||
BT | `packages_stats.ecosystems.npm.public_packages_count` | Number of public npm packages
|
||||
BU | `packages_stats.ecosystems.npm.internal_packages_count` | Number of internal npm packages
|
||||
BV | `packages_stats.ecosystems.npm.user_packages_count` | Number of npm packages owned by user accounts
|
||||
BW | `packages_stats.ecosystems.npm.organization_packages_count` | Number of npm packages owned by organizations
|
||||
BX | `packages_stats.ecosystems.npm.daily_download_count` | Number of downloads of npm packages
|
||||
BY | `packages_stats.ecosystems.npm.daily_update_count` | Number of npm packages updated
|
||||
BZ | `packages_stats.ecosystems.npm.daily_delete_count` | Number of npm packages deleted
|
||||
CA | `packages_stats.ecosystems.npm.daily_create_count` | Number of npm packages created
|
||||
CB | `packages_stats.ecosystems.nuget.registry_enabled` | Whether NuGet is enabled for {% data variables.product.prodname_registry %}
|
||||
CC | `packages_stats.ecosystems.nuget.published_packages_count` | Number of published NuGet packages (private, public, and internal)
|
||||
CD | `packages_stats.ecosystems.nuget.private_packages_count` | Number of private NuGet packages
|
||||
CE | `packages_stats.ecosystems.nuget.public_packages_count` | Number of public NuGet packages
|
||||
CF | `packages_stats.ecosystems.nuget.internal_packages_count` | Number of internal NuGet packages
|
||||
CG | `packages_stats.ecosystems.nuget.user_packages_count` | Number of NuGet packages owned by user accounts
|
||||
CH | `packages_stats.ecosystems.nuget.organization_packages_count` | Number of NuGet packages owned by organizations
|
||||
CI | `packages_stats.ecosystems.nuget.daily_download_count` | Number of downloads of Nuget packages
|
||||
CJ | `packages_stats.ecosystems.nuget.daily_update_count` | Number of NuGet packages updated
|
||||
CK | `packages_stats.ecosystems.nuget.daily_delete_count` | Number of NuGet packages deleted
|
||||
CL | `packages_stats.ecosystems.nuget.daily_create_count` | Number of NuGet packages created
|
||||
CM | `packages_stats.ecosystems.ruby_gems.registry_enabled` | Whether Rubygems is enabled for {% data variables.product.prodname_registry %}
|
||||
CN | `packages_stats.ecosystems.ruby_gems.published_packages_count` | Number of published Rubygems packages (private, public, and internal)
|
||||
CO | `packages_stats.ecosystems.ruby_gems.private_packages_count` | Number of private Rubygems packages
|
||||
CP | `packages_stats.ecosystems.ruby_gems.public_packages_count` | Number of public Rubygems packages
|
||||
CQ | `packages_stats.ecosystems.ruby_gems.internal_packages_count` | Number of internal Rubygems packages
|
||||
CR | `packages_stats.ecosystems.ruby_gems.user_packages_count` | Number of Rubygems packages owned by user accounts
|
||||
CS | `packages_stats.ecosystems.ruby_gems.organization_packages_count` | Number of Rubygems packages owned by organizations
|
||||
CT | `packages_stats.ecosystems.ruby_gems.daily_download_count` | Number of downloads of Rubygems packages
|
||||
CU | `packages_stats.ecosystems.ruby_gems.daily_update_count` | Number of Rubygems packages updated
|
||||
CV | `packages_stats.ecosystems.ruby_gems.daily_delete_count` | Number of Rubygems packages deleted
|
||||
CW | `packages_stats.ecosystems.ruby_gems.daily_create_count` | Number of Rubygems packages created
|
||||
CX | `packages_stats.ecosystems.containers.registry_enabled` | Whether {% data variables.product.prodname_container_registry %} is enabled for {% data variables.product.prodname_registry %}
|
||||
CY | `packages_stats.ecosystems.containers.published_packages_count` | Number of published container images (private, public, and internal)
|
||||
CZ | `packages_stats.ecosystems.containers.private_packages_count` | Number of private container images
|
||||
DA | `packages_stats.ecosystems.containers.public_packages_count` | Number of public container images
|
||||
DB | `packages_stats.ecosystems.containers.internal_packages_count` | Number of internal container images
|
||||
DC | `packages_stats.ecosystems.containers.user_packages_count` | Number of container images owned by user accounts
|
||||
DD | `packages_stats.ecosystems.containers.organization_packages_count` | Number of container images owned by organizations
|
||||
DE |`packages_stats.ecosystems.containers.daily_download_count` | Number of downloads of container images
|
||||
DF |`packages_stats.ecosystems.containers.daily_update_count` | Number of container images updated
|
||||
DG |`packages_stats.ecosystems.containers.daily_delete_count` | Number of container images deleted
|
||||
DH | `packages_stats.ecosystems.containers.daily_create_count` | Number of container images created | {% endif %}
|
||||
| CSV column | Name | Description |
|
||||
| ---------- | ---- | ----------- |
|
||||
| A | `github_connect.features_enabled` | Array of {% data variables.product.prodname_github_connect %} features that are enabled for your instance (see "[AUTOTITLE](/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features)" ) |
|
||||
| B | `host_name` | The hostname for your instance |
|
||||
| C | `dormant_users.dormancy_threshold` | The length of time a user must be inactive to be considered dormant |
|
||||
| D | `dormant_users.total_dormant_users` | Number of dormant user accounts |
|
||||
| E | `ghes_version` | The version of {% data variables.product.product_name %} that your instance is running |
|
||||
| F | `server_id` | The UUID generated for your instance
|
||||
| G | `collection_date` | The date the metrics were collected |
|
||||
| H | `schema_version` | The version of the database schema used to store this data |
|
||||
| I | `ghe_stats.comments.total_commit_comments` | Number of comments on commits |
|
||||
| J | `ghe_stats.comments.total_gist_comments` | Number of comments on gists |
|
||||
| K | `ghe_stats.comments.total_issue_comments` | Number of comments on issues |
|
||||
| L | `ghe_stats.comments.total_pull_request_comments` | Number of comments on pull requests |
|
||||
| M | `ghe_stats.gists.total_gists` | Number of gists (both secret and public) |
|
||||
| N | `ghe_stats.gists.private_gists` | Number of secret gists |
|
||||
| O | `ghe_stats.gists.public_gists` | Number of public gists |
|
||||
| P | `ghe_stats.hooks.total_hooks` | Number of pre-receive hooks (both active and inactive) |
|
||||
| Q | `ghe_stats.hooks.active_hooks` | Number of active pre-receive hooks |
|
||||
| R | `ghe_stats.hooks.inactive_hooks` | Number of inactive pre-receive hooks |
|
||||
| S | `ghe_stats.issues.total_issues` | Number of issues (both open and closed) |
|
||||
| T | `ghe_stats.issues.open_issues` | Number of open issues |
|
||||
| U | `ghe_stats.issues.closed_issues` | Number of closed issues |
|
||||
| V | `ghe_stats.milestones.total_milestones` | Number of milestones (both open and closed) |
|
||||
| W | `ghe_stats.milestones.open_milestones` | Number of open milestones |
|
||||
| X | `ghe_stats.milestones.closed_milestones` | Number of closed milestones |
|
||||
| Y | `ghe_stats.orgs.total_orgs` | Number of organizations (both enabled and disabled) |
|
||||
| Z | `ghe_stats.orgs.disabled_orgs` | Number of disabled organizations |
|
||||
| AA | `ghe_stats.orgs.total_teams` | Number of teams |
|
||||
| AB | `ghe_stats.orgs.total_team_members` | Number of team members |
|
||||
| AC | `ghe_stats.pages.total_pages` | Number of {% data variables.product.prodname_pages %} sites |
|
||||
| AD | `ghe_stats.pulls.total_pulls` | Number of pull requests |
|
||||
| AE | `ghe_stats.pulls.merged_pulls` | Number of merged pull requests |
|
||||
| AF | `ghe_stats.pulls.mergeable_pulls` | Number of pull requests that are currently mergeable |
|
||||
| AG | `ghe_stats.pulls.unmergeable_pulls` | Number of pull requests that are currently unmergeable |
|
||||
| AH | `ghe_stats.repos.total_repos` | Number of repositories (both upstream repositories and forks) |
|
||||
| AI | `ghe_stats.repos.root_repos` | Number of upstream repositories |
|
||||
| AJ | `ghe_stats.repos.fork_repos` | Number of forks |
|
||||
| AK | `ghe_stats.repos.org_repos` | Number of repositories owned by organizations |
|
||||
| AL | `ghe_stats.repos.total_pushes` | Number of pushes to repositories |
|
||||
| AM | `ghe_stats.repos.total_wikis` | Number of wikis |
|
||||
| AN | `ghe_stats.users.total_users` | Number of user accounts |
|
||||
| AO | `ghe_stats.users.admin_users` | Number of user accounts that are site administrators |
|
||||
| AP | `ghe_stats.users.suspended_users` | Number of user accounts that are suspended |
|
||||
| {% ifversion actions-server-statistics %} |
|
||||
| AQ | `actions_stats.number_of_repos_using_actions` | Number of repositories using {% data variables.product.prodname_actions %} |
|
||||
| AR | `actions_stats.percentage_of_repos_using_actions` | Percentage of repositories using {% data variables.product.prodname_actions %} |
|
||||
| AS | `packages_stats.registry_enabled` | Whether {% data variables.product.prodname_registry %} with repository-scoped packages is enabled for {% data variables.location.product_location %} |
|
||||
| AT | `packages_stats.registry_v2_enabled` | Whether {% data variables.product.prodname_registry %} with granular permissions is enabled for {% data variables.location.product_location %} |
|
||||
| AU | `packages_stats.ecosystems.docker.registry_enabled` | Whether Docker is enabled for {% data variables.product.prodname_registry %} |
|
||||
| AV | `packages_stats.ecosystems.docker.published_packages_count` | Number of published Docker images (private, public, and internal) |
|
||||
| AW | `packages_stats.ecosystems.docker.private_packages_count`| Number of private Docker images |
|
||||
| AX | `packages_stats.ecosystems.docker.public_packages_count` | Number of public Docker images |
|
||||
| AY | `packages_stats.ecosystems.docker.internal_packages_count` | Number of internal Docker images |
|
||||
| AZ | `packages_stats.ecosystems.docker.user_packages_count` | Number of Docker images owned by users |
|
||||
| BA | `packages_stats.ecosystems.docker.organization_packages_count` | Number of Docker images owned by organizations |
|
||||
| BB | `packages_stats.ecosystems.docker.daily_download_count` | Number of downloads of Docker images |
|
||||
| BC | `packages_stats.ecosystems.docker.daily_update_count` | Number of Docker images updated |
|
||||
| BD | `packages_stats.ecosystems.docker.daily_delete_count` | Number of Docker images deleted |
|
||||
| BE | `packages_stats.ecosystems.docker.daily_create_count` | Number of Docker images created |
|
||||
| BF | `packages_stats.ecosystems.maven.registry_enabled` | Whether Maven is enabled for {% data variables.product.prodname_registry %} |
|
||||
| BG | `packages_stats.ecosystems.maven.published_packages_count` | Number of published Maven packages (private, public, and internal) |
|
||||
| BH | `packages_stats.ecosystems.maven.private_packages_count` | Number of private Maven packages |
|
||||
| BI | `packages_stats.ecosystems.maven.public_packages_count` | Number of public Maven packages |
|
||||
| BJ | `packages_stats.ecosystems.maven.internal_packages_count` | Number of internal Maven packages |
|
||||
| BK | `packages_stats.ecosystems.maven.user_packages_count` | Number of Maven packages owned by user accounts |
|
||||
| BL | `packages_stats.ecosystems.maven.organization_packages_count` | Number of Maven packages owned by organizations |
|
||||
| BM | `packages_stats.ecosystems.maven.daily_download_count` | Number of downloads of Maven packages |
|
||||
| BN | `packages_stats.ecosystems.maven.daily_update_count` | Number of Maven packages updated |
|
||||
| BO | `packages_stats.ecosystems.maven.daily_delete_count` | Number of Maven packages deleted |
|
||||
| BP | `packages_stats.ecosystems.maven.daily_create_count` | Number of Maven packages created |
|
||||
| BQ | `packages_stats.ecosystems.npm.registry_enabled` | Whether npm is enabled for {% data variables.product.prodname_registry %} |
|
||||
| BR | `packages_stats.ecosystems.npm.published_packages_count` | Number of published npm packages (private, public, and internal) |
|
||||
| BS | `packages_stats.ecosystems.npm.private_packages_count` | Number of private npm packages |
|
||||
| BT | `packages_stats.ecosystems.npm.public_packages_count` | Number of public npm packages |
|
||||
| BU | `packages_stats.ecosystems.npm.internal_packages_count` | Number of internal npm packages |
|
||||
| BV | `packages_stats.ecosystems.npm.user_packages_count` | Number of npm packages owned by user accounts |
|
||||
| BW | `packages_stats.ecosystems.npm.organization_packages_count` | Number of npm packages owned by organizations |
|
||||
| BX | `packages_stats.ecosystems.npm.daily_download_count` | Number of downloads of npm packages |
|
||||
| BY | `packages_stats.ecosystems.npm.daily_update_count` | Number of npm packages updated |
|
||||
| BZ | `packages_stats.ecosystems.npm.daily_delete_count` | Number of npm packages deleted |
|
||||
| CA | `packages_stats.ecosystems.npm.daily_create_count` | Number of npm packages created |
|
||||
| CB | `packages_stats.ecosystems.nuget.registry_enabled` | Whether NuGet is enabled for {% data variables.product.prodname_registry %} |
|
||||
| CC | `packages_stats.ecosystems.nuget.published_packages_count` | Number of published NuGet packages (private, public, and internal) |
|
||||
| CD | `packages_stats.ecosystems.nuget.private_packages_count` | Number of private NuGet packages |
|
||||
| CE | `packages_stats.ecosystems.nuget.public_packages_count` | Number of public NuGet packages |
|
||||
| CF | `packages_stats.ecosystems.nuget.internal_packages_count` | Number of internal NuGet packages |
|
||||
| CG | `packages_stats.ecosystems.nuget.user_packages_count` | Number of NuGet packages owned by user accounts |
|
||||
| CH | `packages_stats.ecosystems.nuget.organization_packages_count` | Number of NuGet packages owned by organizations |
|
||||
| CI | `packages_stats.ecosystems.nuget.daily_download_count` | Number of downloads of Nuget packages |
|
||||
| CJ | `packages_stats.ecosystems.nuget.daily_update_count` | Number of NuGet packages updated |
|
||||
| CK | `packages_stats.ecosystems.nuget.daily_delete_count` | Number of NuGet packages deleted |
|
||||
| CL | `packages_stats.ecosystems.nuget.daily_create_count` | Number of NuGet packages created |
|
||||
| CM | `packages_stats.ecosystems.ruby_gems.registry_enabled` | Whether Rubygems is enabled for {% data variables.product.prodname_registry %} |
|
||||
| CN | `packages_stats.ecosystems.ruby_gems.published_packages_count` | Number of published Rubygems packages (private, public, and internal) |
|
||||
| CO | `packages_stats.ecosystems.ruby_gems.private_packages_count` | Number of private Rubygems packages |
|
||||
| CP | `packages_stats.ecosystems.ruby_gems.public_packages_count` | Number of public Rubygems packages |
|
||||
| CQ | `packages_stats.ecosystems.ruby_gems.internal_packages_count` | Number of internal Rubygems packages |
|
||||
| CR | `packages_stats.ecosystems.ruby_gems.user_packages_count` | Number of Rubygems packages owned by user accounts |
|
||||
| CS | `packages_stats.ecosystems.ruby_gems.organization_packages_count` | Number of Rubygems packages owned by organizations |
|
||||
| CT | `packages_stats.ecosystems.ruby_gems.daily_download_count` | Number of downloads of Rubygems packages |
|
||||
| CU | `packages_stats.ecosystems.ruby_gems.daily_update_count` | Number of Rubygems packages updated |
|
||||
| CV | `packages_stats.ecosystems.ruby_gems.daily_delete_count` | Number of Rubygems packages deleted |
|
||||
| CW | `packages_stats.ecosystems.ruby_gems.daily_create_count` | Number of Rubygems packages created |
|
||||
| CX | `packages_stats.ecosystems.containers.registry_enabled` | Whether {% data variables.product.prodname_container_registry %} is enabled for {% data variables.product.prodname_registry %} |
|
||||
| CY | `packages_stats.ecosystems.containers.published_packages_count` | Number of published container images (private, public, and internal) |
|
||||
| CZ | `packages_stats.ecosystems.containers.private_packages_count` | Number of private container images |
|
||||
| DA | `packages_stats.ecosystems.containers.public_packages_count` | Number of public container images |
|
||||
| DB | `packages_stats.ecosystems.containers.internal_packages_count` | Number of internal container images |
|
||||
| DC | `packages_stats.ecosystems.containers.user_packages_count` | Number of container images owned by user accounts |
|
||||
| DD | `packages_stats.ecosystems.containers.organization_packages_count` | Number of container images owned by organizations |
|
||||
| DE |`packages_stats.ecosystems.containers.daily_download_count` | Number of downloads of container images |
|
||||
| DF |`packages_stats.ecosystems.containers.daily_update_count` | Number of container images updated |
|
||||
| DG |`packages_stats.ecosystems.containers.daily_delete_count` | Number of container images deleted |
|
||||
| DH | `packages_stats.ecosystems.containers.daily_create_count` | Number of container images created |
|
||||
| {% endif %} |
|
||||
|
||||
## {% data variables.product.prodname_server_statistics %} data examples
|
||||
|
||||
|
|
|
|||
|
|
@ -39,16 +39,18 @@ You cannot search for entries using text. You can, however, construct search que
|
|||
|
||||
## Search query filters
|
||||
|
||||
Filter| Description
|
||||
--------------:| -----------
|
||||
`Yesterday's activity` | All actions created in the past day.
|
||||
`Enterprise account management` | All actions in the `business` category.
|
||||
`Organization membership` | All actions for when a new user was invited to join an organization.
|
||||
`Team management` | All actions related to team management.<br/>- When a user account or repository was added or removed from a team<br/>- When a team maintainer was promoted or demoted<br/>- When a team was deleted
|
||||
`Repository management` | All actions for repository management.<br/>- When a repository was created or deleted<br/>- When the repository visibility was changed<br/>- When a team was added or removed from a repository{% ifversion ghec %}
|
||||
`Billing updates` | All actions concerning how your enterprise pays for {% data variables.product.prodname_dotcom %} and for when your billing email address was changed.{% endif %}
|
||||
`Hook activity` | All actions for webhooks and pre-receive hooks.
|
||||
`Security management` | All actions concerning SSH keys, deploy keys, security keys, 2FA, and SAML single sign-on credential authorization, and vulnerability alerts for repositories.
|
||||
| Filter | Description |
|
||||
| ------:| ----------- |
|
||||
| `Yesterday's activity` | All actions created in the past day. |
|
||||
| `Enterprise account management` | All actions in the `business` category. |
|
||||
| `Organization membership` | All actions for when a new user was invited to join an organization. |
|
||||
| `Team management` | All actions related to team management.<br/>- When a user account or repository was added or removed from a team<br/>- When a team maintainer was promoted or demoted<br/>- When a team was deleted |
|
||||
| `Repository management` | All actions for repository management.<br/>- When a repository was created or deleted<br/>- When the repository visibility was changed<br/>- When a team was added or removed from a repository |
|
||||
| {% ifversion ghec %} |
|
||||
| `Billing updates` | All actions concerning how your enterprise pays for {% data variables.product.prodname_dotcom %} and for when your billing email address was changed. |
|
||||
| {% endif %} |
|
||||
| `Hook activity` | All actions for webhooks and pre-receive hooks. |
|
||||
| `Security management` | All actions concerning SSH keys, deploy keys, security keys, 2FA, and SAML single sign-on credential authorization, and vulnerability alerts for repositories. |
|
||||
|
||||
## Search query syntax
|
||||
|
||||
|
|
@ -58,44 +60,59 @@ You can compose a search query from one or more `key:value` pairs. For example,
|
|||
|
||||
The `key:value` pairs that can be used in a search query are:
|
||||
|
||||
Key | Value
|
||||
-------------- | --------------------------------------------------------
|
||||
`action` | Name of the audited action.
|
||||
`actor` | Name of the user account that initiated the action.
|
||||
{%- ifversion ghes %}
|
||||
`actor_id` | ID of the user account that initiated the action.{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`actor_ip` | IP address from which the action was initiated.{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`business` | Name of the enterprise affected by the action (if applicable).{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`business_id` | ID of the enterprise affected by the action (if applicable).{% endif %}
|
||||
{%- ifversion token-audit-log %}
|
||||
`created` | Time at which the action occurred.{% ifversion ghes %} If querying the audit log from the site admin dashboard, use `created_at` instead.{% endif %}
|
||||
`country` | Name of the country where the actor was when performing the action.
|
||||
`country_code` | Two-letter short code of the country where the actor was when performing the action.
|
||||
{%- ifversion ghes %}
|
||||
`from` | View from which the action was initiated.{% endif %}
|
||||
`hashed_token` | The token used to authenticate for the action (if applicable, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/identifying-audit-log-events-performed-by-an-access-token)"). {% endif %}
|
||||
`ip` | IP address of the actor.
|
||||
{%- ifversion ghes %}
|
||||
`note` | Miscellaneous event-specific information (in either plain text or JSON format).{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`oauth_app_id` | ID of the {% data variables.product.prodname_oauth_app %} associated with the action.{% endif %}
|
||||
`operation` | Operation type that corresponds with the action. Operation types are `create`, `access`, `modify`, `remove`, `authentication`, `transfer`, and `restore`.
|
||||
{%- ifversion ghes %}
|
||||
`org` | Name of the organization affected by the action (if applicable).{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`org_id` | ID of the organization affected by the action (if applicable).{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`repo_id` | ID of the repository affected by the action (if applicable).{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`repository` | Name with owner of the repository where the action occurred (such as `"octocat/octo-repo"`).{% endif %}
|
||||
{%- ifversion ghec %}
|
||||
`repository` | Name with owner of the repository where the action occurred (such as `octocat/octo-repo`).{% endif %}
|
||||
{%- ifversion ghes %}
|
||||
`user_id` | ID of the user affected by the action.{% endif %}
|
||||
`user` | Name of the user affected by the action.
|
||||
| Key | Value |
|
||||
| ------------ | ----- |
|
||||
| `action` | Name of the audited action. |
|
||||
| `actor` | Name of the user account that initiated the action. |
|
||||
| {% ifversion ghes %} |
|
||||
| `actor_id` | ID of the user account that initiated the action.
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `actor_ip` | IP address from which the action was initiated. |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `business` | Name of the enterprise affected by the action (if applicable). |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `business_id` | ID of the enterprise affected by the action (if applicable). |
|
||||
| {% endif %} |
|
||||
| {% ifversion token-audit-log %} |
|
||||
| `created` | Time at which the action occurred.{% ifversion ghes %} If querying the audit log from the site admin dashboard, use `created_at` instead. |
|
||||
| {% endif %} |
|
||||
| `country` | Name of the country where the actor was when performing the action. |
|
||||
| `country_code` | Two-letter short code of the country where the actor was when performing the action. |
|
||||
| {% ifversion ghes %} |
|
||||
| `from` | View from which the action was initiated. |
|
||||
| {% endif %} |
|
||||
| `hashed_token` | The token used to authenticate for the action (if applicable, see "[AUTOTITLE](/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/identifying-audit-log-events-performed-by-an-access-token)"). |
|
||||
| {% endif %} |
|
||||
| `ip` | IP address of the actor. |
|
||||
| {% ifversion ghes %} |
|
||||
| `note` | Miscellaneous event-specific information (in either plain text or JSON format). |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `oauth_app_id` | ID of the {% data variables.product.prodname_oauth_app %} associated with the action. |
|
||||
| {% endif %} |
|
||||
| `operation` | Operation type that corresponds with the action. Operation types are `create`, `access`, `modify`, `remove`, `authentication`, `transfer`, and `restore`. |
|
||||
| {% ifversion ghes %} |
|
||||
| `org` | Name of the organization affected by the action (if applicable). |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `org_id` | ID of the organization affected by the action (if applicable). |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `repo_id` | ID of the repository affected by the action (if applicable). |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `repository` | Name with owner of the repository where the action occurred (such as `"octocat/octo-repo"`). |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghec %} |
|
||||
| `repository` | Name with owner of the repository where the action occurred (such as `octocat/octo-repo`). |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `user_id` | ID of the user affected by the action. |
|
||||
| {% endif %} |
|
||||
| `user` | Name of the user affected by the action. |
|
||||
|
||||
To see actions grouped by category, you can also use the action qualifier as a `key:value` pair. For more information, see "[Search based on the action performed](#search-based-on-the-action-performed)."
|
||||
|
||||
|
|
|
|||
|
|
@ -89,9 +89,7 @@ The following log files contain events from your instance's {% data variables.en
|
|||
|
||||
| Path | Description |
|
||||
| :- | :- |
|
||||
{%- ifversion ghes %}
|
||||
| <pre>/var/log/enterprise-manage/audit.log</pre> | Records activity in the instance's {% data variables.enterprise.management_console %}. |
|
||||
{%- endif %}
|
||||
| <pre>/var/log/enterprise-manage/unicorn.log</pre> | Records HTTP and HTTPS operations that administrators perform in the {% data variables.enterprise.management_console %} using the web UI or REST API. |
|
||||
|
||||
### Log files for instance configuration
|
||||
|
|
@ -101,9 +99,9 @@ The following log files contain events related to the configuration of your inst
|
|||
| Path | Description |
|
||||
| :- | :- |
|
||||
| <pre>/data/user/common/ghe-config.log</pre> | Records events associated with {% ifversion unique-config-run-logs %}the latest{% else %}each{% endif %} configuration run. If a configuration run fails, output to the log stops. This log also records information about migrations that run during the process of upgrading an instance's software. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-config-apply)." |
|
||||
{%- ifversion unique-config-run-logs %}
|
||||
| {% ifversion unique-config-run-logs %} |
|
||||
| <pre>/data/user/config-apply/logs/YYYYMMDD/*</pre> | Stores log files for previous configuration runs. The instance stores the files in a directory that reflects the date, and each file name reflects the node and the ID of the run. |
|
||||
{%- endif %}
|
||||
| {% endif %} |
|
||||
|
||||
### Log files for search
|
||||
|
||||
|
|
|
|||
|
|
@ -57,15 +57,17 @@ The web application flow to authorize users for your app is:
|
|||
|
||||
This endpoint takes the following input parameters.
|
||||
|
||||
Query parameter | Type | Required? |Description
|
||||
-----|------|---------|-----
|
||||
`client_id`|`string` | Required | The client ID you received from GitHub when you {% ifversion fpt or ghec %}[registered](https://github.com/settings/applications/new){% else %}registered{% endif %}.
|
||||
`redirect_uri`|`string` |Strongly recommended| The URL in your application where users will be sent after authorization. See details below about [redirect urls](#redirect-urls).
|
||||
`login` | `string` | Optional| Suggests a specific account to use for signing in and authorizing the app.
|
||||
`scope`|`string` |Context dependent| A space-delimited list of [scopes](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps). If not provided, `scope` defaults to an empty list for users that have not authorized any scopes for the application. For users who have authorized scopes for the application, the user won't be shown the OAuth authorization page with the list of scopes. Instead, this step of the flow will automatically complete with the set of scopes the user has authorized for the application. For example, if a user has already performed the web flow twice and has authorized one token with `user` scope and another token with `repo` scope, a third web flow that does not provide a `scope` will receive a token with `user` and `repo` scope.
|
||||
`state` | `string` |Strongly recommended| {% data reusables.apps.state_description %}
|
||||
`allow_signup`|`string` | Optional | Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow. The default is `true`. Use `false` when a policy prohibits signups.
|
||||
{% ifversion oauth_account_picker %}`prompt` | `string` | Optional | Forces the account picker to appear if set to `select_account`. The account picker will also appear if the application has a non-HTTP redirect URI or if the user has multiple accounts signed in. {% endif %}
|
||||
| Query parameter | Type | Required? | Description |
|
||||
| --------------- | ---- | --------- | ----------- |
|
||||
| `client_id`|`string` | Required | The client ID you received from GitHub when you {% ifversion fpt or ghec %}[registered](https://github.com/settings/applications/new){% else %}registered{% endif %}. |
|
||||
| `redirect_uri`|`string` |Strongly recommended| The URL in your application where users will be sent after authorization. See details below about [redirect urls](#redirect-urls). |
|
||||
| `login` | `string` | Optional| Suggests a specific account to use for signing in and authorizing the app. |
|
||||
| `scope`|`string` |Context dependent| A space-delimited list of [scopes](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps). If not provided, `scope` defaults to an empty list for users that have not authorized any scopes for the application. For users who have authorized scopes for the application, the user won't be shown the OAuth authorization page with the list of scopes. Instead, this step of the flow will automatically complete with the set of scopes the user has authorized for the application. For example, if a user has already performed the web flow twice and has authorized one token with `user` scope and another token with `repo` scope, a third web flow that does not provide a `scope` will receive a token with `user` and `repo` scope. |
|
||||
| `state` | `string` |Strongly recommended| {% data reusables.apps.state_description %} |
|
||||
| `allow_signup`|`string` | Optional | Whether or not unauthenticated users will be offered an option to sign up for GitHub during the OAuth flow. The default is `true`. Use `false` when a policy prohibits signups. |
|
||||
| {% ifversion oauth_account_picker %} |
|
||||
| `prompt` | `string` | Optional | Forces the account picker to appear if set to `select_account`. The account picker will also appear if the application has a non-HTTP redirect URI or if the user has multiple accounts signed in. |
|
||||
| {% endif %} |
|
||||
|
||||
The PKCE (Proof Key for Code Exchange) parameters `code_challenge` and `code_challenge_method` are not supported at this time. CORS pre-flight requests (OPTIONS) are not supported at this time.
|
||||
|
||||
|
|
|
|||
|
|
@ -30,26 +30,40 @@ The security log lists all actions performed within the last 90 days.
|
|||
|
||||
The events listed in your security log are triggered by your actions. Actions are grouped into different categories. For the full list of events in each category, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/security-log-events)."
|
||||
|
||||
| Category name | Description
|
||||
|------------------|-------------------{% ifversion fpt or ghec %}
|
||||
| `billing` | Contains all activities related to your billing information.
|
||||
| `codespaces` | Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see "[AUTOTITLE](/codespaces/overview)."
|
||||
| `copilot` | Contains all activities related to {% data variables.product.prodname_copilot_business_short %}. For more information, see "[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot)."
|
||||
| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement.
|
||||
| `marketplace_listing`| Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}.{% endif %}{% ifversion security-log-oauth-access-tokens %}
|
||||
| `oauth_access` | Contains all activities related to OAuth access tokens.{% endif %}
|
||||
| `oauth_authorization` | Contains all activities related to authorizing {% data variables.product.prodname_oauth_apps %}. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)."{% ifversion passkeys %}
|
||||
| `passkey` | Contains activities related to your passkeys. See "[AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys)."{% endif %}{% ifversion fpt or ghec %}
|
||||
| `payment_method` | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.{% endif %}{% ifversion pat-v2%}
|
||||
| `personal_access_token` | Contains activities related to {% data variables.product.pat_v2 %}s. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."{% endif %}
|
||||
| `profile_picture`| Contains all activities related to your profile picture.
|
||||
| `project` | Contains all activities related to {% data variables.projects.projects_v1_boards %}.
|
||||
| `public_key` | Contains all activities related to [your public SSH keys](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).
|
||||
| `repo`| Contains all activities related to the repositories you own.{% ifversion fpt or ghec %}
|
||||
| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% ifversion ghes %}
|
||||
| `team` | Contains all activities related to teams you are a part of.{% endif %}
|
||||
| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/authentication/securing-your-account-with-two-factor-authentication-2fa).
|
||||
| `user` | Contains all activities related to your account.
|
||||
| Category name | Description |
|
||||
| ------------- | ----------- |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
| `billing` | Contains all activities related to your billing information. |
|
||||
| `codespaces` | Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see "[AUTOTITLE](/codespaces/overview)." |
|
||||
| `copilot` | Contains all activities related to {% data variables.product.prodname_copilot_business_short %}. For more information, see "[AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot)." |
|
||||
| `marketplace_agreement_signature` | Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. |
|
||||
| `marketplace_listing`| Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}. |
|
||||
| {% endif %} |
|
||||
| {% ifversion security-log-oauth-access-tokens %} |
|
||||
| `oauth_access` | Contains all activities related to OAuth access tokens. |
|
||||
| {% endif %} |
|
||||
| `oauth_authorization` | Contains all activities related to authorizing {% data variables.product.prodname_oauth_apps %}. For more information, see "[AUTOTITLE](/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps)." |
|
||||
| {% ifversion passkeys %} |
|
||||
| `passkey` | Contains activities related to your passkeys. See "[AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys)." |
|
||||
| {% endif %} |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
| `payment_method` | Contains all activities related to paying for your {% data variables.product.prodname_dotcom %} subscription.
|
||||
| {% endif %} |
|
||||
| {% ifversion pat-v2%} |
|
||||
| `personal_access_token` | Contains activities related to {% data variables.product.pat_v2 %}s. For more information, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)." |
|
||||
| {% endif %} |
|
||||
| `profile_picture`| Contains all activities related to your profile picture. |
|
||||
| `project` | Contains all activities related to {% data variables.projects.projects_v1_boards %}. |
|
||||
| `public_key` | Contains all activities related to [your public SSH keys](/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). |
|
||||
| `repo`| Contains all activities related to the repositories you own. |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
| `sponsors` | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[AUTOTITLE](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)") |
|
||||
| {% endif %} |
|
||||
| {% ifversion ghes %} |
|
||||
| `team` | Contains all activities related to teams you are a part of. |
|
||||
| {% endif %} |
|
||||
| `two_factor_authentication` | Contains all activities related to [two-factor authentication](/authentication/securing-your-account-with-two-factor-authentication-2fa). |
|
||||
| `user` | Contains all activities related to your account. |
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
|
|
|
|||
|
|
@ -64,16 +64,18 @@ You must specify `<database>`, `--format`, and `--output`. You can specify addit
|
|||
| Option | Required | Usage |
|
||||
|--------|:--------:|-----|
|
||||
| `<database>` | {% octicon "check" aria-label="Required" %} | Specify the path for the directory that contains the {% data variables.product.prodname_codeql %} database to analyze. |
|
||||
| `<packs,queries>` | {% octicon "x" aria-label="Optional" %} | Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. To see the other query suites included in the {% data variables.product.prodname_codeql_cli %} bundle, look in `/<extraction-root>/qlpacks/codeql/<language>-queries/codeql-suites`. For information about creating your own query suite, see [AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites) in the documentation for the {% data variables.product.prodname_codeql_cli %}.
|
||||
| <code><span style="white-space: nowrap;">--format</span></code> | {% octicon "check" aria-label="Required" %} | Specify the format for the results file generated during analysis. A number of different formats are supported, including CSV, [SARIF](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#sarif-file), and graph formats. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)."
|
||||
| <code><span style="white-space: nowrap;">--output</span></code> | {% octicon "check" aria-label="Required" %} | Specify the location where you want to save the SARIF results file, including the desired filename with the `.sarif` extension.
|
||||
| <code><span style="white-space: nowrap;">--sarif-category</span></code> | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository.<br><br>Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.|
|
||||
| `<packs,queries>` | {% octicon "x" aria-label="Optional" %} | Specify {% data variables.product.prodname_codeql %} packs or queries to run. To run the standard queries used for {% data variables.product.prodname_code_scanning %}, omit this parameter. To see the other query suites included in the {% data variables.product.prodname_codeql_cli %} bundle, look in `/<extraction-root>/qlpacks/codeql/<language>-queries/codeql-suites`. For information about creating your own query suite, see [AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/creating-codeql-query-suites) in the documentation for the {% data variables.product.prodname_codeql_cli %}. |
|
||||
| <code><span style="white-space: nowrap;">--format</span></code> | {% octicon "check" aria-label="Required" %} | Specify the format for the results file generated during analysis. A number of different formats are supported, including CSV, [SARIF](https://codeql.github.com/docs/codeql-overview/codeql-glossary/#sarif-file), and graph formats. For upload to {% data variables.product.company_short %} this should be: {% ifversion fpt or ghec %}`sarif-latest`{% else %}`sarifv2.1.0`{% endif %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)." |
|
||||
| <code><span style="white-space: nowrap;">--output</span></code> | {% octicon "check" aria-label="Required" %} | Specify the location where you want to save the SARIF results file, including the desired filename with the `.sarif` extension. |
|
||||
| <code><span style="white-space: nowrap;">--sarif-category</span></code> | {% octicon "question" aria-label="Required with multiple results sets" %} | Optional for single database analysis. Required to define the language when you analyze multiple databases for a single commit in a repository.<br><br>Specify a category to include in the SARIF results file for this analysis. A category is used to distinguish multiple analyses for the same tool and commit, but performed on different languages or different parts of the code. |
|
||||
| <code><span style="white-space: nowrap;">--sarif-add-baseline-file-info</span></code> | {% octicon "x" aria-label="Optional" %} | **Recommended.** Use to submit file coverage information to the {% data variables.code-scanning.tool_status_page %}. For more information, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page#how-codeql-defines-scanned-files)." |
|
||||
| <code><span style="white-space: nowrap;">--sarif-include-query-help</span></code> | {% octicon "x" aria-label="Optional" %} | Specify whether to include query help in the SARIF output. One of: `always`: Include query help for all queries. `custom_queries_only` (default): Include query help only for custom queries, that is, queries in query packs which are not of the form `codeql/<lang>-queries`. `never`: Do not include query help for any queries. Any query help for custom queries included in the SARIF output will be displayed in any code scanning alerts for the query. For more information, see "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli#including-query-help-for-custom-codeql-queries-in-sarif-files)."{% ifversion codeql-packs %}
|
||||
| `<packs>` | {% octicon "x" aria-label="Optional" %} | Use if you want to include {% data variables.product.prodname_codeql %} query packs in your analysis. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} packs](/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs#downloading-and-using-codeql-query-packs)."
|
||||
| <code><span style="white-space: nowrap;">--download</span></code> | {% octicon "x" aria-label="Optional" %} | Use if some of your {% data variables.product.prodname_codeql %} query packs are not yet on disk and need to be downloaded before running queries.{% endif %}
|
||||
| <code><span style="white-space: nowrap;">--threads</span></code> | {% octicon "x" aria-label="Optional" %} | Use if you want to use more than one thread to run queries. The default value is `1`. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify `0`.
|
||||
| <code><span style="white-space: nowrap;">--verbose</span></code> | {% octicon "x" aria-label="Optional" %} | Use to get more detailed information about the analysis process and diagnostic data from the database creation process.
|
||||
| <code><span style="white-space: nowrap;">--sarif-include-query-help</span></code> | {% octicon "x" aria-label="Optional" %} | Specify whether to include query help in the SARIF output. One of: `always`: Include query help for all queries. `custom_queries_only` (default): Include query help only for custom queries, that is, queries in query packs which are not of the form `codeql/<lang>-queries`. `never`: Do not include query help for any queries. Any query help for custom queries included in the SARIF output will be displayed in any code scanning alerts for the query. For more information, see "[AUTOTITLE](/code-security/codeql-cli/using-the-advanced-functionality-of-the-codeql-cli/using-custom-queries-with-the-codeql-cli#including-query-help-for-custom-codeql-queries-in-sarif-files)." |
|
||||
| {% ifversion codeql-packs %} |
|
||||
| `<packs>` | {% octicon "x" aria-label="Optional" %} | Use if you want to include {% data variables.product.prodname_codeql %} query packs in your analysis. For more information, see "[Downloading and using {% data variables.product.prodname_codeql %} packs](/code-security/codeql-cli/getting-started-with-the-codeql-cli/customizing-analysis-with-codeql-packs#downloading-and-using-codeql-query-packs)." |
|
||||
| <code><span style="white-space: nowrap;">--download</span></code> | {% octicon "x" aria-label="Optional" %} | Use if some of your {% data variables.product.prodname_codeql %} query packs are not yet on disk and need to be downloaded before running queries. |
|
||||
| {% endif %} |
|
||||
| <code><span style="white-space: nowrap;">--threads</span></code> | {% octicon "x" aria-label="Optional" %} | Use if you want to use more than one thread to run queries. The default value is `1`. You can specify more threads to speed up query execution. To set the number of threads to the number of logical processors, specify `0`. |
|
||||
| <code><span style="white-space: nowrap;">--verbose</span></code> | {% octicon "x" aria-label="Optional" %} | Use to get more detailed information about the analysis process and diagnostic data from the database creation process. |
|
||||
| <code><span style="white-space: nowrap;">--threat-model</span></code> | {% octicon "x" aria-label="Optional" %} | (Beta) Use to add threat models to configure additional sources in your {% data variables.product.prodname_codeql %} analysis. During the beta, threat models are supported only by Java analysis. For more information, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/database-analyze#--threat-modelname)." |
|
||||
|
||||
{% note %}
|
||||
|
|
|
|||
|
|
@ -58,13 +58,15 @@ codeql github upload-results \
|
|||
```
|
||||
|
||||
| Option | Required | Usage |
|
||||
|--------|:--------:|-----|
|
||||
| <code><span style="white-space: nowrap;">--repository</span></code> | {% octicon "check" aria-label="Required" %} | Specify the _OWNER/NAME_ of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)."
|
||||
| <code><span style="white-space: nowrap;">--ref</span></code> | {% octicon "check" aria-label="Required" %} | Specify the name of the `ref` you checked out and analyzed so that the results can be matched to the correct code. For a branch use: `refs/heads/BRANCH-NAME`, for the head commit of a pull request use `refs/pull/NUMBER/head`, or for the {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request use `refs/pull/NUMBER/merge`.
|
||||
| <code><span style="white-space: nowrap;">--commit</span></code> | {% octicon "check" aria-label="Required" %} | Specify the full SHA of the commit you analyzed.
|
||||
| <code><span style="white-space: nowrap;">--sarif</span></code> | {% octicon "check" aria-label="Required" %} | Specify the SARIF file to load.{% ifversion ghes %}
|
||||
| <code><span style="white-space: nowrap;">--github-url</span></code> | {% octicon "check" aria-label="Required" %} | Specify the URL for {% data variables.product.product_name %}.{% endif %}
|
||||
| <code><span style="white-space: nowrap;">--github-auth-stdin</span></code> | {% octicon "x" aria-label="Optional" %} | Pass the CLI the {% data variables.product.prodname_github_app %} or {% data variables.product.pat_generic %} created for authentication with {% data variables.product.company_short %}'s REST API from your secret store via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token.
|
||||
| ------ | :------: | ----- |
|
||||
| <code><span style="white-space: nowrap;">--repository</span></code> | {% octicon "check" aria-label="Required" %} | Specify the _OWNER/NAME_ of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." |
|
||||
| <code><span style="white-space: nowrap;">--ref</span></code> | {% octicon "check" aria-label="Required" %} | Specify the name of the `ref` you checked out and analyzed so that the results can be matched to the correct code. For a branch use: `refs/heads/BRANCH-NAME`, for the head commit of a pull request use `refs/pull/NUMBER/head`, or for the {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request use `refs/pull/NUMBER/merge`. |
|
||||
| <code><span style="white-space: nowrap;">--commit</span></code> | {% octicon "check" aria-label="Required" %} | Specify the full SHA of the commit you analyzed. |
|
||||
| <code><span style="white-space: nowrap;">--sarif</span></code> | {% octicon "check" aria-label="Required" %} | Specify the SARIF file to load. |
|
||||
| {% ifversion ghes %} |
|
||||
| <code><span style="white-space: nowrap;">--github-url</span></code> | {% octicon "check" aria-label="Required" %} | Specify the URL for {% data variables.product.product_name %}. |
|
||||
| {% endif %} |
|
||||
| <code><span style="white-space: nowrap;">--github-auth-stdin</span></code> | {% octicon "x" aria-label="Optional" %} | Pass the CLI the {% data variables.product.prodname_github_app %} or {% data variables.product.pat_generic %} created for authentication with {% data variables.product.company_short %}'s REST API from your secret store via standard input. This is not needed if the command has access to a `GITHUB_TOKEN` environment variable set with this token. |
|
||||
|
||||
For more information, see "[AUTOTITLE](/code-security/codeql-cli/codeql-cli-manual/github-upload-results)."
|
||||
|
||||
|
|
|
|||
|
|
@ -56,10 +56,12 @@ You can search the database, and use qualifiers to narrow your search. For examp
|
|||
{% data reusables.search.date_gt_lt %}
|
||||
|
||||
| Qualifier | Example |
|
||||
| ------------- | ------------- |
|
||||
| ---------- | ------- |
|
||||
| `type:reviewed`| [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories for security vulnerabilities. |
|
||||
{% ifversion GH-advisory-db-supports-malware %}| `type:malware` | [**type:malware**](https://github.com/advisories?query=type%3Amalware) will show malware advisories. |
|
||||
{% endif %}| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. |
|
||||
| {% ifversion GH-advisory-db-supports-malware %} |
|
||||
| `type:malware` | [**type:malware**](https://github.com/advisories?query=type%3Amalware) will show malware advisories. |
|
||||
| {% endif %} |
|
||||
| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. |
|
||||
| `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. |
|
||||
| `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. |
|
||||
| `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting npm packages. |
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ You can assign different types of credit to people.
|
|||
| Credit type | Reason |
|
||||
|-----------------------|--------------------------------------------------------------------------------------------|
|
||||
| Finder | Identifies the vulnerability |
|
||||
| Reporter | Notifies the vendor of the vulnerability to a CNA |
|
||||
| Reporter | Notifies the vendor of the vulnerability to a CNA |
|
||||
| Analyst | Validates the vulnerability to ensure accuracy or severity |
|
||||
| Coordinator | Facilitates the coordinated response process |
|
||||
| Remediation developer | Prepares a code change or other remediation plans |
|
||||
|
|
@ -67,6 +67,7 @@ You can assign different types of credit to people.
|
|||
| Remediation verifier | Tests and verifies the vulnerability or its remediation |
|
||||
| Tool | Names of tools used in vulnerability discovery or identification |
|
||||
| Sponsor | Supports the vulnerability identification or remediation activities |
|
||||
|
||||
{% endif %}
|
||||
|
||||
If someone accepts credit, the person's username appears in the "Credits" section of the security advisory. Anyone with read access to the repository can see the advisory and the people who accepted credit for it.
|
||||
|
|
|
|||
|
|
@ -98,8 +98,10 @@ In enterprise-level views, you can limit the data to repositories owned by a sin
|
|||
|
||||
| Qualifier | Description | Views |
|
||||
| -------- | -------- | ------ |
|
||||
| `owner` | Display data for all repositories owned by one account owner. | Most views |{% ifversion ghec %}
|
||||
| `owner-type` | Display data for all repositories owned by an organization or a user account in your enterprise. | Most views, but only if you are an owner of an {% data variables.enterprise.prodname_emu_enterprise %} |{% endif %}
|
||||
| `owner` | Display data for all repositories owned by one account owner. | Most views |
|
||||
| {% ifversion ghec %} |
|
||||
| `owner-type` | Display data for all repositories owned by an organization or a user account in your enterprise. | Most views, but only if you are an owner of an {% data variables.enterprise.prodname_emu_enterprise %} |
|
||||
| {% endif %} |
|
||||
| `org` | Display data for repositories owned by one organization. | {% data variables.product.prodname_dependabot_alerts %} and {% data variables.product.prodname_code_scanning %} alerts |
|
||||
|
||||
{% elsif security-overview-org-risk-coverage-enterprise %}
|
||||
|
|
|
|||
|
|
@ -39,16 +39,22 @@ As a repository maintainer, you can use the community standards checklist to see
|
|||
|
||||
You can create defaults in your organization or personal account for the following community health files:
|
||||
|
||||
Community health file | Description
|
||||
--- | ---{% ifversion fpt or ghec %}
|
||||
_CODE_OF_CONDUCT.md_ | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)."{% endif %}
|
||||
_CONTRIBUTING.md_ | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."{% ifversion discussion-category-forms %}
|
||||
Discussion category forms | Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository. For more information, see "[AUTOTITLE](/discussions/managing-discussions-for-your-community/creating-discussion-category-forms)."{% endif %}{% ifversion fpt or ghec %}
|
||||
_FUNDING.yml_ | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)."{% endif %}
|
||||
_GOVERNANCE.md_ | A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made.
|
||||
Issue and pull request templates and _config.yml_ | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."
|
||||
_SECURITY.md_ | A SECURITY file gives instructions on how to report a security vulnerability in your project and description that hyperlinks the file. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository)."
|
||||
_SUPPORT.md_ | A SUPPORT file lets people know about ways to get help with your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project)."
|
||||
| Community health file | Description |
|
||||
| --- | --- |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
| _CODE_OF_CONDUCT.md_ | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)." |
|
||||
| {% endif %} |
|
||||
| _CONTRIBUTING.md_ | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." |
|
||||
| {% ifversion discussion-category-forms %} |
|
||||
| Discussion category forms | Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository. For more information, see "[AUTOTITLE](/discussions/managing-discussions-for-your-community/creating-discussion-category-forms)." |
|
||||
| {% endif %} |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
| _FUNDING.yml_ | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)." |
|
||||
| {% endif %} |
|
||||
| _GOVERNANCE.md_ | A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made. |
|
||||
| Issue and pull request templates and _config.yml_ | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." |
|
||||
| _SECURITY.md_ | A SECURITY file gives instructions on how to report a security vulnerability in your project and description that hyperlinks the file. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository)." |
|
||||
| _SUPPORT.md_ | A SUPPORT file lets people know about ways to get help with your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project)." |
|
||||
|
||||
You cannot create a default license file. License files must be added to individual repositories so the file will be included when a project is cloned, packaged, or downloaded.
|
||||
|
||||
|
|
|
|||
|
|
@ -30,8 +30,8 @@ The following sections list some of the available keyboard shortcuts, organized
|
|||
|
||||
## Site wide shortcuts
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------|
|
||||
|<kbd>S</kbd> or <kbd>/</kbd> | Focus the search bar. For more information, see "[AUTOTITLE](/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 "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)."
|
||||
|<kbd>Option</kbd>+<kbd>↑</kbd> (Mac) or </br> <kbd>Alt</kbd>+<kbd>↑</kbd> (Windows/Linux) | Move focus from an element to its hovercard |
|
||||
|
|
@ -39,53 +39,57 @@ The following sections list some of the available keyboard shortcuts, organized
|
|||
|
||||
## Repositories
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>G</kbd> <kbd>C</kbd> | Go to the **Code** tab
|
||||
|<kbd>G</kbd> <kbd>I</kbd> | Go to the **Issues** tab. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues)."
|
||||
|<kbd>G</kbd> <kbd>P</kbd> | Go to the **Pull requests** tab. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)."
|
||||
|<kbd>G</kbd> <kbd>A</kbd> | Go to the **Actions** tab. For more information, see "[AUTOTITLE](/actions/learn-github-actions)."
|
||||
|<kbd>G</kbd> <kbd>B</kbd> | Go to the **Projects** tab. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)."
|
||||
|<kbd>G</kbd> <kbd>W</kbd> | Go to the **Wiki** tab. For more information, see "[AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis)."{% ifversion discussions %}
|
||||
|<kbd>G</kbd> <kbd>G</kbd> | Go to the **Discussions** tab. For more information, see "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."{% endif %}
|
||||
|<kbd>G</kbd> <kbd>W</kbd> | Go to the **Wiki** tab. For more information, see "[AUTOTITLE](/communities/documenting-your-project-with-wikis/about-wikis)." |
|
||||
| {% ifversion discussions %} |
|
||||
|<kbd>G</kbd> <kbd>G</kbd> | Go to the **Discussions** tab. For more information, see "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
|
||||
| {% endif %} |
|
||||
|
||||
## Source code editing
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------{% ifversion fpt or ghec %}
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------|
|
||||
| {% ifversion fpt or ghec %} |
|
||||
|<kbd>.</kbd> | Opens a repository or pull request in the {% data variables.codespaces.serverless %} editor, in the same browser tab. You must be signed in to use the editor. For more information, see "[AUTOTITLE](/codespaces/the-githubdev-web-based-editor)."
|
||||
|<kbd>></kbd> | Opens a repository or pull request in the {% data variables.codespaces.serverless %} editor, in a new browser tab. You must be signed in to use the editor. For more information, see "[AUTOTITLE](/codespaces/the-githubdev-web-based-editor)."{% endif %}
|
||||
|<kbd>Command</kbd>+<kbd>B</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | Inserts Markdown formatting for bolding text
|
||||
|<kbd>Command</kbd>+<kbd>I</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) | Inserts Markdown formatting for italicizing text
|
||||
|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Inserts Markdown formatting for creating a link
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Windows/Linux) | Inserts Markdown formatting for an ordered list
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Windows/Linux) | Inserts Markdown formatting for an unordered list
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Windows/Linux) | Inserts Markdown formatting for a quote
|
||||
|<kbd>E</kbd> | Open source code file in the **Edit file** tab
|
||||
|<kbd>Command</kbd>+<kbd>F</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>F</kbd> (Windows/Linux) | Start searching in file editor
|
||||
|<kbd>Command</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>G</kbd> (Windows/Linux) | Find next
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> (Windows/Linux) | Find previous
|
||||
|<kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>F</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>F</kbd> (Windows/Linux) | Replace
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>F</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd> (Windows/Linux) | Replace all
|
||||
|<kbd>Alt</kbd>+<kbd>G</kbd> | Jump to line
|
||||
|<kbd>Command</kbd>+<kbd>Z</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Z</kbd> (Windows/Linux) | Undo
|
||||
|<kbd>Command</kbd>+<kbd>Y</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Y</kbd> (Windows/Linux) | Redo
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> | Toggles between the **Edit file** and **Preview changes** tabs
|
||||
|<kbd>Command</kbd>+<kbd>S</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>S</kbd> (Windows/Linux) | Write a commit message
|
||||
|<kbd>></kbd> | Opens a repository or pull request in the {% data variables.codespaces.serverless %} editor, in a new browser tab. You must be signed in to use the editor. For more information, see "[AUTOTITLE](/codespaces/the-githubdev-web-based-editor)." |
|
||||
| {% endif %} |
|
||||
|<kbd>Command</kbd>+<kbd>B</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | Inserts Markdown formatting for bolding text |
|
||||
|<kbd>Command</kbd>+<kbd>I</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) | Inserts Markdown formatting for italicizing text |
|
||||
|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Inserts Markdown formatting for creating a link |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Windows/Linux) | Inserts Markdown formatting for an ordered list |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Windows/Linux) | Inserts Markdown formatting for an unordered list |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Windows/Linux) | Inserts Markdown formatting for a quote |
|
||||
|<kbd>E</kbd> | Open source code file in the **Edit file** tab |
|
||||
|<kbd>Command</kbd>+<kbd>F</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>F</kbd> (Windows/Linux) | Start searching in file editor |
|
||||
|<kbd>Command</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>G</kbd> (Windows/Linux) | Find next |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>G</kbd> (Windows/Linux) | Find previous |
|
||||
|<kbd>Command</kbd>+<kbd>Option</kbd>+<kbd>F</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>F</kbd> (Windows/Linux) | Replace |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>F</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd> (Windows/Linux) | Replace all |
|
||||
|<kbd>Alt</kbd>+<kbd>G</kbd> | Jump to line |
|
||||
|<kbd>Command</kbd>+<kbd>Z</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Z</kbd> (Windows/Linux) | Undo |
|
||||
|<kbd>Command</kbd>+<kbd>Y</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Y</kbd> (Windows/Linux) | Redo |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> | Toggles between the **Edit file** and **Preview changes** tabs |
|
||||
|<kbd>Command</kbd>+<kbd>S</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>S</kbd> (Windows/Linux) | Write a commit message |
|
||||
|
||||
For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirror.net/doc/manual.html#commands).
|
||||
|
||||
## Source code browsing
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>t</kbd> | Activates the file finder
|
||||
|<kbd>l</kbd> | Jump to a line in your code
|
||||
|<kbd>w</kbd> | Switch to a new branch or tag
|
||||
|<kbd>y</kbd> | Expand a URL to its canonical form. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/getting-permanent-links-to-files)."
|
||||
|<kbd>i</kbd> | Show or hide comments on diffs. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)."
|
||||
|<kbd>a</kbd> | Show or hide annotations on diffs
|
||||
|<kbd>b</kbd> | Open blame view. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/viewing-a-file)."
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------|
|
||||
|<kbd>t</kbd> | Activates the file finder |
|
||||
|<kbd>l</kbd> | Jump to a line in your code |
|
||||
|<kbd>w</kbd> | Switch to a new branch or tag |
|
||||
|<kbd>y</kbd> | Expand a URL to its canonical form. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/getting-permanent-links-to-files)." |
|
||||
|<kbd>i</kbd> | Show or hide comments on diffs. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." |
|
||||
|<kbd>a</kbd> | Show or hide annotations on diffs |
|
||||
|<kbd>b</kbd> | Open blame view. For more information, see "[AUTOTITLE](/repositories/working-with-files/using-files/viewing-a-file)." |
|
||||
|
||||
{% ifversion code-view-ui %}
|
||||
|
||||
|
|
@ -93,8 +97,8 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr
|
|||
|
||||
If you view a code file in a repository using the **Code** view and click on any line in the file, you will see a cursor. You can then navigate within the content of the file, also known as a blob (binary large object), using keyboard shortcuts.
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------|
|
||||
|<kbd>Shift</kbd>+<kbd>J</kbd>| Highlights the line that is currently selected by the cursor within the code file
|
||||
|<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>C</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>C</kbd> (Windows/Linux) | If a line of code is currently selected, this shortcut opens the line menu for that line, appearing under {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} to the left of the line
|
||||
| {% ifversion code-search-upgrade %} |
|
||||
|
|
@ -105,57 +109,61 @@ If you view a code file in a repository using the **Code** view and click on any
|
|||
|
||||
## Comments
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Command</kbd>+<kbd>B</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | Inserts Markdown formatting for bolding text
|
||||
|<kbd>Command</kbd>+<kbd>I</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) | Inserts Markdown formatting for italicizing text
|
||||
|<kbd>Command</kbd>+<kbd>E</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>E</kbd> (Windows/Linux) | Inserts Markdown formatting for code or a command within a line
|
||||
|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Inserts Markdown formatting for creating a link
|
||||
|<kbd>Command</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>V</kbd> (Windows/Linux) | Creates a Markdown link when applied over highlighted text
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) | Toggles between the **Write** and **Preview** comment tabs
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (Windows/Linux) | Pastes HTML link as plain text
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>V</kbd> (Windows/Linux) | Pastes HTML link as plain text
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Windows/Linux) | Inserts Markdown formatting for an ordered list
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Windows/Linux) | Inserts Markdown formatting for an unordered list
|
||||
|<kbd>Command</kbd>+<kbd>Enter</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Enter</kbd> (Windows/Linux) | Submits a comment
|
||||
|<kbd>Ctrl</kbd>+<kbd>.</kbd> and then <kbd>Ctrl</kbd>+<kbd>[saved reply number]</kbd> | Opens saved replies menu and then autofills comment field with a saved reply. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies)."
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Windows/Linux) | Inserts Markdown formatting for a quote{% ifversion fpt or ghec %}
|
||||
|<kbd>Command</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>G</kbd> (Windows/Linux) | Insert a suggestion. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." |{% endif %}
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------|
|
||||
|<kbd>Command</kbd>+<kbd>B</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | Inserts Markdown formatting for bolding text |
|
||||
|<kbd>Command</kbd>+<kbd>I</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) | Inserts Markdown formatting for italicizing text |
|
||||
|<kbd>Command</kbd>+<kbd>E</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>E</kbd> (Windows/Linux) | Inserts Markdown formatting for code or a command within a line |
|
||||
|<kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Inserts Markdown formatting for creating a link |
|
||||
|<kbd>Command</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>V</kbd> (Windows/Linux) | Creates a Markdown link when applied over highlighted text |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) | Toggles between the **Write** and **Preview** comment tabs |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>V</kbd> (Windows/Linux) | Pastes HTML link as plain text |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>V</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>V</kbd> (Windows/Linux) | Pastes HTML link as plain text |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>7</kbd> (Windows/Linux) | Inserts Markdown formatting for an ordered list |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>8</kbd> (Windows/Linux) | Inserts Markdown formatting for an unordered list |
|
||||
|<kbd>Command</kbd>+<kbd>Enter</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Enter</kbd> (Windows/Linux) | Submits a comment |
|
||||
|<kbd>Ctrl</kbd>+<kbd>.</kbd> and then <kbd>Ctrl</kbd>+<kbd>[saved reply number]</kbd> | Opens saved replies menu and then autofills comment field with a saved reply. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-saved-replies/about-saved-replies)." |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>.</kbd> (Windows/Linux) | Inserts Markdown formatting for a quote |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
|<kbd>Command</kbd>+<kbd>G</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>G</kbd> (Windows/Linux) | Insert a suggestion. For more information, see "[AUTOTITLE](/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 "[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-text)." |
|
||||
|
||||
## Issue and pull request lists
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>C</kbd> | Create an issue
|
||||
|<kbd>Command</kbd>+<kbd>/</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>/</kbd> (Windows/Linux) | Focus your cursor on the issues or pull requests search bar. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."||
|
||||
|<kbd>U</kbd> | Filter by author
|
||||
|<kbd>L</kbd> | Filter by or edit labels. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."
|
||||
|<kbd>Alt</kbd> and click | While filtering by labels, exclude labels. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."
|
||||
|<kbd>M</kbd> | Filter by or edit milestones. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone)."
|
||||
|<kbd>A</kbd> | Filter by or edit assignee. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."
|
||||
|<kbd>O</kbd> or <kbd>Enter</kbd> | Open issue
|
||||
|<kbd>Command</kbd>+<kbd>/</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>/</kbd> (Windows/Linux) | Focus your cursor on the issues or pull requests search bar. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)."|
|
||||
|<kbd>U</kbd> | Filter by author |
|
||||
|<kbd>L</kbd> | Filter by or edit labels. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)." |
|
||||
|<kbd>Alt</kbd> and click | While filtering by labels, exclude labels. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)." |
|
||||
|<kbd>M</kbd> | Filter by or edit milestones. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/filtering-issues-and-pull-requests-by-milestone)." |
|
||||
|<kbd>A</kbd> | Filter by or edit assignee. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests)." |
|
||||
|<kbd>O</kbd> or <kbd>Enter</kbd> | Open issue |
|
||||
|
||||
## Issues and pull requests
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Q</kbd> | Request a reviewer. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)."
|
||||
|<kbd>M</kbd> | Set a milestone. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests)."
|
||||
|<kbd>L</kbd> | Apply a label. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-a-label)."
|
||||
|<kbd>A</kbd> | Set an assignee. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)."
|
||||
|<kbd>X</kbd> | Link an issue or pull request from the same repository. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)."
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) | Toggles between the **Write** and **Preview** tabs{% ifversion fpt or ghec %}
|
||||
|<kbd>Alt</kbd> and click | When creating an issue from a task list, open the new issue form in the current tab by holding <kbd>Alt</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)."
|
||||
|<kbd>Shift</kbd> and click | When creating an issue from a task list, open the new issue form in a new tab by holding <kbd>Shift</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)."
|
||||
|<kbd>Command</kbd> and click (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd> and click (Windows/Linux) | When creating an issue from a task list, open the new issue form in the new window by holding <kbd>Command</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)."{% endif %}
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Q</kbd> | Request a reviewer. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)." |
|
||||
|<kbd>M</kbd> | Set a milestone. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/associating-milestones-with-issues-and-pull-requests)." |
|
||||
|<kbd>L</kbd> | Apply a label. For more information, see "[AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels#applying-a-label)." |
|
||||
|<kbd>A</kbd> | Set an assignee. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users)." |
|
||||
|<kbd>X</kbd> | Link an issue or pull request from the same repository. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)." |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) | Toggles between the **Write** and **Preview** tabs |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
|<kbd>Alt</kbd> and click | When creating an issue from a task list, open the new issue form in the current tab by holding <kbd>Alt</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." |
|
||||
|<kbd>Shift</kbd> and click | When creating an issue from a task list, open the new issue form in a new tab by holding <kbd>Shift</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." |
|
||||
|<kbd>Command</kbd> and click (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd> and click (Windows/Linux) | When creating an issue from a task list, open the new issue form in the new window by holding <kbd>Command</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd> and clicking the {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. For more information, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)." |
|
||||
| {% endif %} |
|
||||
|
||||
## "Files changed" tab in pull requests
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>C</kbd> | Open the **Commits** dropdown menu to filter which commits are shown in the diffs
|
||||
|<kbd>T</kbd> | Move your cursor to the "Filter changed files" field
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>C</kbd> | Open the **Commits** dropdown menu to filter which commits are shown in the diffs |
|
||||
|<kbd>T</kbd> | Move your cursor to the "Filter changed files" field |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> (Windows/Linux) | Submit a review comment |
|
||||
|<kbd>Option</kbd> and click (Mac) or <kbd>Alt</kbd> and click (Windows/Linux) | Toggle between collapsing and expanding all outdated or resolved review comments in a pull request (for example, 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 "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)."|
|
||||
|
|
@ -166,44 +174,44 @@ If you view a code file in a repository using the **Code** view and click on any
|
|||
|
||||
### Navigating a project
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Command</kbd>+<kbd>f</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>f</kbd> (Windows/Linux) | Focus filter field
|
||||
|<kbd>←</kbd> | Move focus to the left
|
||||
|<kbd>→</kbd> | Move focus to the right
|
||||
|<kbd>↑</kbd> | Move focus up
|
||||
|<kbd>↓</kbd> | Move focus down
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Command</kbd>+<kbd>f</kbd> (Mac) or <kbd>Ctrl</kbd>+<kbd>f</kbd> (Windows/Linux) | Focus filter field |
|
||||
|<kbd>←</kbd> | Move focus to the left |
|
||||
|<kbd>→</kbd> | Move focus to the right |
|
||||
|<kbd>↑</kbd> | Move focus up |
|
||||
|<kbd>↓</kbd> | Move focus down |
|
||||
|
||||
### Manipulating a project
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Enter</kbd> | Toggle edit mode for the focused cell
|
||||
|<kbd>Escape</kbd> | Cancel editing for the focused cell
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>\ </kbd>(Mac) or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>\ </kbd>(Windows/Linux) | Open row actions menu
|
||||
|<kbd>Shift</kbd>+<kbd>Space</kbd> | Select item
|
||||
|<kbd>Shift</kbd>+<kbd>↓</kbd> | Add cell{% ifversion projects-v2-board-keyboard-shorts %} or card{% endif %} below to selection
|
||||
|<kbd>Shift</kbd>+<kbd>↑</kbd> | Add cell {% ifversion projects-v2-board-keyboard-shorts %}or card{% endif %} above to selection
|
||||
|<kbd>Space</kbd> | Open selected item
|
||||
|<kbd>e</kbd> | Archive selected items
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Enter</kbd> | Toggle edit mode for the focused cell |
|
||||
|<kbd>Escape</kbd> | Cancel editing for the focused cell |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>\ </kbd>(Mac) or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>\ </kbd>(Windows/Linux) | Open row actions menu |
|
||||
|<kbd>Shift</kbd>+<kbd>Space</kbd> | Select item |
|
||||
|<kbd>Shift</kbd>+<kbd>↓</kbd> | Add cell {% ifversion projects-v2-board-keyboard-shorts %} or card{% endif %} below to selection |
|
||||
|<kbd>Shift</kbd>+<kbd>↑</kbd> | Add cell {% ifversion projects-v2-board-keyboard-shorts %}or card{% endif %} above to selection |
|
||||
|<kbd>Space</kbd> | Open selected item |
|
||||
|<kbd>e</kbd> | Archive selected items |
|
||||
|
||||
{% ifversion projects-v2-board-keyboard-shorts %}
|
||||
|
||||
### Moving cards on the board layout
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Enter</kbd> or <kbd>Shift</kbd>+<kbd>Space</kbd> | Start moving the selected card(s)
|
||||
|<kbd>Esc</kbd> | Cancel the move in progress
|
||||
|<kbd>Enter</kbd> | Complete the move in progress
|
||||
|<kbd>↓</kbd> | Move a single card down
|
||||
|<kbd>Command</kbd>+<kbd>↓</kbd> or </br> <kbd>Ctrl</kbd>+<kbd>↓</kbd> (Windows/Linux) | Move a single card to the bottom of the column
|
||||
|<kbd>↑</kbd> | Move a single card up
|
||||
|<kbd>Command</kbd>+<kbd>↑</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>↑</kbd> (Windows/Linux) | Move a single card to the top of the column
|
||||
|<kbd>←</kbd> | Move card(s) left
|
||||
|<kbd>Command</kbd>+<kbd>←</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>←</kbd> (Windows/Linux) | Move card(s) to the leftmost column
|
||||
|<kbd>→</kbd> | Move card(s) right
|
||||
|<kbd>Command</kbd>+<kbd>→</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>→</kbd> (Windows/Linux) | Move card(s) to the rightmost column
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Enter</kbd> or <kbd>Shift</kbd>+<kbd>Space</kbd> | Start moving the selected card(s) |
|
||||
|<kbd>Esc</kbd> | Cancel the move in progress |
|
||||
|<kbd>Enter</kbd> | Complete the move in progress |
|
||||
|<kbd>↓</kbd> | Move a single card down |
|
||||
|<kbd>Command</kbd>+<kbd>↓</kbd> or </br> <kbd>Ctrl</kbd>+<kbd>↓</kbd> (Windows/Linux) | Move a single card to the bottom of the column |
|
||||
|<kbd>↑</kbd> | Move a single card up |
|
||||
|<kbd>Command</kbd>+<kbd>↑</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>↑</kbd> (Windows/Linux) | Move a single card to the top of the column |
|
||||
|<kbd>←</kbd> | Move card(s) left |
|
||||
|<kbd>Command</kbd>+<kbd>←</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>←</kbd> (Windows/Linux) | Move card(s) to the leftmost column |
|
||||
|<kbd>→</kbd> | Move card(s) right |
|
||||
|<kbd>Command</kbd>+<kbd>→</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>→</kbd> (Windows/Linux) | Move card(s) to the rightmost column |
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -215,41 +223,41 @@ If you view a code file in a repository using the **Code** view and click on any
|
|||
|
||||
### Moving a column
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Enter</kbd> or <kbd>Space</kbd> | Start moving the focused column
|
||||
|<kbd>Esc</kbd> | Cancel the move in progress
|
||||
|<kbd>Enter</kbd> | Complete the move in progress
|
||||
|<kbd>←</kbd> or <kbd>H</kbd> | Move column to the left
|
||||
|<kbd>Command</kbd>+<kbd>←</kbd> or <kbd>Command</kbd>+<kbd>H</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>←</kbd> or <kbd>Ctrl</kbd>+<kbd>H</kbd> (Windows/Linux) | Move column to the leftmost position
|
||||
|<kbd>→</kbd> or <kbd>L</kbd> | Move column to the right
|
||||
|<kbd>Command</kbd>+<kbd>→</kbd> or <kbd>Command</kbd>+<kbd>L</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>→</kbd> or <kbd>Ctrl</kbd>+<kbd>L</kbd> (Windows/Linux) | Move column to the rightmost position
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Enter</kbd> or <kbd>Space</kbd> | Start moving the focused column |
|
||||
|<kbd>Esc</kbd> | Cancel the move in progress |
|
||||
|<kbd>Enter</kbd> | Complete the move in progress |
|
||||
|<kbd>←</kbd> or <kbd>H</kbd> | Move column to the left |
|
||||
|<kbd>Command</kbd>+<kbd>←</kbd> or <kbd>Command</kbd>+<kbd>H</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>←</kbd> or <kbd>Ctrl</kbd>+<kbd>H</kbd> (Windows/Linux) | Move column to the leftmost position |
|
||||
|<kbd>→</kbd> or <kbd>L</kbd> | Move column to the right |
|
||||
|<kbd>Command</kbd>+<kbd>→</kbd> or <kbd>Command</kbd>+<kbd>L</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>→</kbd> or <kbd>Ctrl</kbd>+<kbd>L</kbd> (Windows/Linux) | Move column to the rightmost position |
|
||||
|
||||
### Moving a card
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Enter</kbd> or <kbd>Space</kbd> | Start moving the focused card
|
||||
|<kbd>Esc</kbd> | Cancel the move in progress
|
||||
|<kbd>Enter</kbd> | Complete the move in progress
|
||||
|<kbd>↓</kbd> or <kbd>J</kbd> | Move card down
|
||||
|<kbd>Command</kbd>+<kbd>↓</kbd> or <kbd>Command</kbd>+<kbd>J</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>↓</kbd> or <kbd>Ctrl</kbd>+<kbd>J</kbd> (Windows/Linux) | Move card to the bottom of the column
|
||||
|<kbd>↑</kbd> or <kbd>K</kbd> | Move card up
|
||||
|<kbd>Command</kbd>+<kbd>↑</kbd> or <kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>↑</kbd> or <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Move card to the top of the column
|
||||
|<kbd>←</kbd> or <kbd>H</kbd> | Move card to the bottom of the column on the left
|
||||
|<kbd>Shift</kbd>+<kbd>←</kbd> or <kbd>Shift</kbd>+<kbd>H</kbd> | Move card to the top of the column on the left
|
||||
|<kbd>Command</kbd>+<kbd>←</kbd> or <kbd>Command</kbd>+<kbd>H</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>←</kbd> or <kbd>Ctrl</kbd>+<kbd>H</kbd> (Windows/Linux) | Move card to the bottom of the leftmost column
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Enter</kbd> or <kbd>Space</kbd> | Start moving the focused card |
|
||||
|<kbd>Esc</kbd> | Cancel the move in progress |
|
||||
|<kbd>Enter</kbd> | Complete the move in progress |
|
||||
|<kbd>↓</kbd> or <kbd>J</kbd> | Move card down |
|
||||
|<kbd>Command</kbd>+<kbd>↓</kbd> or <kbd>Command</kbd>+<kbd>J</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>↓</kbd> or <kbd>Ctrl</kbd>+<kbd>J</kbd> (Windows/Linux) | Move card to the bottom of the column |
|
||||
|<kbd>↑</kbd> or <kbd>K</kbd> | Move card up |
|
||||
|<kbd>Command</kbd>+<kbd>↑</kbd> or <kbd>Command</kbd>+<kbd>K</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>↑</kbd> or <kbd>Ctrl</kbd>+<kbd>K</kbd> (Windows/Linux) | Move card to the top of the column |
|
||||
|<kbd>←</kbd> or <kbd>H</kbd> | Move card to the bottom of the column on the left |
|
||||
|<kbd>Shift</kbd>+<kbd>←</kbd> or <kbd>Shift</kbd>+<kbd>H</kbd> | Move card to the top of the column on the left |
|
||||
|<kbd>Command</kbd>+<kbd>←</kbd> or <kbd>Command</kbd>+<kbd>H</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>←</kbd> or <kbd>Ctrl</kbd>+<kbd>H</kbd> (Windows/Linux) | Move card to the bottom of the leftmost column |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>←</kbd> or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>H</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>←</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>H</kbd> (Windows/Linux) | Move card to the top of the leftmost column
|
||||
|<kbd>→</kbd> | Move card to the bottom of the column on the right
|
||||
|<kbd>Shift</kbd>+<kbd>→</kbd> or <kbd>Shift</kbd>+<kbd>L</kbd> | Move card to the top of the column on the right
|
||||
|<kbd>Command</kbd>+<kbd>→</kbd> or <kbd>Command</kbd>+<kbd>L</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>→</kbd> or <kbd>Ctrl</kbd>+<kbd>L</kbd> (Windows/Linux) | Move card to the bottom of the rightmost column
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>→</kbd> or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>→</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> (Windows/Linux) | Move card to the bottom of the rightmost column
|
||||
|<kbd>→</kbd> | Move card to the bottom of the column on the right |
|
||||
|<kbd>Shift</kbd>+<kbd>→</kbd> or <kbd>Shift</kbd>+<kbd>L</kbd> | Move card to the top of the column on the right |
|
||||
|<kbd>Command</kbd>+<kbd>→</kbd> or <kbd>Command</kbd>+<kbd>L</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>→</kbd> or <kbd>Ctrl</kbd>+<kbd>L</kbd> (Windows/Linux) | Move card to the bottom of the rightmost column |
|
||||
|<kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>→</kbd> or <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>→</kbd> or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>L</kbd> (Windows/Linux) | Move card to the bottom of the rightmost column |
|
||||
|
||||
### Previewing a card
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Esc</kbd> | Close the card preview pane
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Esc</kbd> | Close the card preview pane |
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -257,34 +265,34 @@ If you view a code file in a repository using the **Code** view and click on any
|
|||
|
||||
## {% data variables.product.prodname_actions %}
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>Command</kbd>+<kbd>Space </kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Space</kbd> (Windows/Linux) | In the workflow editor, get suggestions for your workflow file.
|
||||
|<kbd>G</kbd> <kbd>F</kbd> | Go to the workflow file
|
||||
|<kbd>Shift</kbd>+<kbd>T</kbd> or <kbd>T</kbd> | Toggle timestamps in logs
|
||||
|<kbd>Shift</kbd>+<kbd>F</kbd> or <kbd>F</kbd> | Toggle full-screen logs
|
||||
|<kbd>Esc</kbd> | Exit full-screen logs
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>Command</kbd>+<kbd>Space </kbd> (Mac) or </br> <kbd>Ctrl</kbd>+<kbd>Space</kbd> (Windows/Linux) | In the workflow editor, get suggestions for your workflow file. |
|
||||
|<kbd>G</kbd> <kbd>F</kbd> | Go to the workflow file |
|
||||
|<kbd>Shift</kbd>+<kbd>T</kbd> or <kbd>T</kbd> | Toggle timestamps in logs |
|
||||
|<kbd>Shift</kbd>+<kbd>F</kbd> or <kbd>F</kbd> | Toggle full-screen logs |
|
||||
|<kbd>Esc</kbd> | Exit full-screen logs |
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Notifications
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>E</kbd> | Mark as done
|
||||
|<kbd>Shift</kbd>+<kbd>U</kbd>| Mark as unread
|
||||
|<kbd>Shift</kbd>+<kbd>I</kbd>| Mark as read
|
||||
|<kbd>Shift</kbd>+<kbd>M</kbd> | Unsubscribe
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>E</kbd> | Mark as done |
|
||||
|<kbd>Shift</kbd>+<kbd>U</kbd>| Mark as unread |
|
||||
|<kbd>Shift</kbd>+<kbd>I</kbd>| Mark as read |
|
||||
|<kbd>Shift</kbd>+<kbd>M</kbd> | Unsubscribe |
|
||||
|
||||
## Network graph
|
||||
|
||||
| Keyboard shortcut | Description
|
||||
|-----------|------------
|
||||
|<kbd>←</kbd> or <kbd>H</kbd> | Scroll left
|
||||
|<kbd>→</kbd> or <kbd>L</kbd> | Scroll right
|
||||
|<kbd>↑</kbd> or <kbd>K</kbd> | Scroll up
|
||||
|<kbd>↓</kbd> or <kbd>J</kbd> | Scroll down
|
||||
|<kbd>Shift</kbd>+<kbd>←</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>H</kbd> (Windows/Linux) | Scroll all the way left
|
||||
|<kbd>Shift</kbd>+<kbd>→</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>L</kbd> (Windows/Linux) | Scroll all the way right
|
||||
|<kbd>Shift</kbd>+<kbd>↑</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>K</kbd> (Windows/Linux) | Scroll all the way up
|
||||
|<kbd>Shift</kbd>+<kbd>↓</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>J</kbd> (Windows/Linux) | Scroll all the way down
|
||||
| Keyboard shortcut | Description |
|
||||
|-----------|------------ |
|
||||
|<kbd>←</kbd> or <kbd>H</kbd> | Scroll left |
|
||||
|<kbd>→</kbd> or <kbd>L</kbd> | Scroll right |
|
||||
|<kbd>↑</kbd> or <kbd>K</kbd> | Scroll up |
|
||||
|<kbd>↓</kbd> or <kbd>J</kbd> | Scroll down |
|
||||
|<kbd>Shift</kbd>+<kbd>←</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>H</kbd> (Windows/Linux) | Scroll all the way left |
|
||||
|<kbd>Shift</kbd>+<kbd>→</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>L</kbd> (Windows/Linux) | Scroll all the way right |
|
||||
|<kbd>Shift</kbd>+<kbd>↑</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>K</kbd> (Windows/Linux) | Scroll all the way up |
|
||||
|<kbd>Shift</kbd>+<kbd>↓</kbd> (Mac) or </br> <kbd>Shift</kbd>+<kbd>J</kbd> (Windows/Linux) | Scroll all the way down |
|
||||
|
|
|
|||
|
|
@ -26,30 +26,30 @@ When you include a permission in a custom organization role, any users with that
|
|||
|
||||
{% rowheaders %}
|
||||
|
||||
Permission | Description | More information
|
||||
------------ | -------------|--------------------
|
||||
Manage custom organization roles | Access to create, view, update, and delete custom organization roles within the organization. This permission does not allow a user to assign custom roles. | "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles)"
|
||||
View organization roles | Access to view the organization's custom organization roles. | "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles)"
|
||||
Manage custom repository roles | Access to create, view, update, and delete the organization's custom repository roles. |"[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)"
|
||||
View custom repository roles | Access to view the organization's custom repository roles. | "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)"
|
||||
Manage organization webhooks | Access to register and manage webhooks for the organization. Users with this permission will be able to view webhook payloads, which may contain metadata for repositories in the organization. | "[AUTOTITLE](/rest/orgs/webhooks#about-organization-webhooks)"
|
||||
{%- ifversion ghec %}
|
||||
Manage organization OAuth application policies | Access to the "OAuth application policy" settings for the organization. | "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)"
|
||||
{%- endif %}
|
||||
{%- ifversion repository-properties %}
|
||||
Edit custom properties values at the organization level | Access to set custom property values on all repositories in the organization. | "[AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)"
|
||||
Manage the organization's custom properties definitions | Access to create and edit custom property definitions for the organization. | "[AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)"
|
||||
{%- endif %}
|
||||
{%- ifversion repo-rules-enterprise %}
|
||||
Manage organization ref update rules and rulesets | Access to manage rulesets and view ruleset insights at the organization level. | "[AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization)"
|
||||
{%- endif %}
|
||||
View organization audit log | Access to the audit log for the organization. The audit log may contain metadata for repositories in the organization. | "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)"
|
||||
Manage organization Actions policies | Access to manage all settings on the "Actions General" settings page, except for self-hosted runners settings. | "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)"
|
||||
Manage organization runners and runner groups | Access to create and manage GitHub-hosted runners, self-hosted runners, and runner groups, and control where self-hosted runners can be created. | "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#overview-of-github-hosted-runners)"<br><br>"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)"
|
||||
Manage organization Actions secrets | Access to create and manage Actions organization secrets. | "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-an-organization)"
|
||||
Manage organization Actions variables | Access to create and manage Actions organization variables. | "[AUTOTITLE](/actions/learn-github-actions/variables#creating-configuration-variables-for-an-organization)"
|
||||
{%- ifversion actions-usage-metrics %}
|
||||
View organization Actions usage metrics | View {% data variables.product.prodname_actions %} usage metrics for your organization. | "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)"
|
||||
{%- endif %}
|
||||
| Permission | Description | More information |
|
||||
| ------------ | -------------|-------------------- |
|
||||
| Manage custom organization roles | Access to create, view, update, and delete custom organization roles within the organization. This permission does not allow a user to assign custom roles. | "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles)" |
|
||||
| View organization roles | Access to view the organization's custom organization roles. | "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-organization-roles)" |
|
||||
| Manage custom repository roles | Access to create, view, update, and delete the organization's custom repository roles. |"[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)" |
|
||||
| View custom repository roles | Access to view the organization's custom repository roles. | "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)" |
|
||||
| Manage organization webhooks | Access to register and manage webhooks for the organization. Users with this permission will be able to view webhook payloads, which may contain metadata for repositories in the organization. | "[AUTOTITLE](/rest/orgs/webhooks#about-organization-webhooks)" |
|
||||
| {% ifversion ghec %} |
|
||||
Manage organization OAuth application policies | Access to the "OAuth application policy" settings for the organization. | "[AUTOTITLE](/organizations/managing-oauth-access-to-your-organizations-data/about-oauth-app-access-restrictions)" |
|
||||
| {% endif %} |
|
||||
| {% ifversion repository-properties %} |
|
||||
| Edit custom properties values at the organization level | Access to set custom property values on all repositories in the organization. | "[AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)" |
|
||||
| Manage the organization's custom properties definitions | Access to create and edit custom property definitions for the organization. | "[AUTOTITLE](/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)" |
|
||||
| {% endif %} |
|
||||
| {% ifversion repo-rules-enterprise %} |
|
||||
| Manage organization ref update rules and rulesets | Access to manage rulesets and view ruleset insights at the organization level. | "[AUTOTITLE](/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization)" |
|
||||
| {% endif %} |
|
||||
| View organization audit log | Access to the audit log for the organization. The audit log may contain metadata for repositories in the organization. | "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization)" |
|
||||
| Manage organization Actions policies | Access to manage all settings on the "Actions General" settings page, except for self-hosted runners settings. | "[AUTOTITLE](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization)" |
|
||||
| Manage organization runners and runner groups | Access to create and manage GitHub-hosted runners, self-hosted runners, and runner groups, and control where self-hosted runners can be created. | "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners#overview-of-github-hosted-runners)"<br><br>"[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)" |
|
||||
| Manage organization Actions secrets | Access to create and manage Actions organization secrets. | "[AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-an-organization)" |
|
||||
| Manage organization Actions variables | Access to create and manage Actions organization variables. | "[AUTOTITLE](/actions/learn-github-actions/variables#creating-configuration-variables-for-an-organization)" |
|
||||
| {% ifversion actions-usage-metrics %} |
|
||||
| View organization Actions usage metrics | View {% data variables.product.prodname_actions %} usage metrics for your organization. | "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-usage-metrics-for-github-actions)" |
|
||||
| {% endif %} |
|
||||
|
||||
{% endrowheaders %}
|
||||
|
|
|
|||
|
|
@ -112,7 +112,8 @@ Some of the features listed below are limited to organizations using {% data var
|
|||
| {% ifversion fpt or ghec %} |
|
||||
| [View and install packages](/packages/learn-github-packages) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Publish packages](/packages/learn-github-packages/publishing-a-package) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Delete and restore packages](/packages/learn-github-packages/deleting-and-restoring-a-package) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% endif %}
|
||||
| [Delete and restore packages](/packages/learn-github-packages/deleting-and-restoring-a-package) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {% endif %} |
|
||||
| Manage [topics](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/classifying-your-repository-with-topics) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| Enable wikis and restrict wiki editors | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| Enable {% data variables.projects.projects_v1_boards %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
|
|
@ -124,7 +125,8 @@ Some of the features listed below are limited to organizations using {% data var
|
|||
| Manage [branch protection rules](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/managing-a-branch-protection-rule){% ifversion repo-rules %} and [repository rulesets](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets){% endif %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {% ifversion repo-rules %} |
|
||||
| View [rulesets for a repository](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
{% endif %}| [Push to protected branches](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {%- endif %} |
|
||||
| [Push to protected branches](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| Merge pull requests on protected branches, even if there are no approving reviews | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| Create tags that match a [tag protection rule](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| Delete tags that match a [tag protection rule](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
|
|
@ -152,7 +154,6 @@ Some of the features listed below are limited to organizations using {% data var
|
|||
| Display a sponsor button (see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)") | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {% endif %} |
|
||||
| Create autolink references to external resources, like Jira or Zendesk (see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-autolinks-to-reference-external-resources)") | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {% ifversion discussions %} |
|
||||
| [Enable {% data variables.product.prodname_discussions %}](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/enabling-or-disabling-github-discussions-for-a-repository) in a repository | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Create and edit categories](/discussions/managing-discussions-for-your-community/managing-categories-for-discussions) for {% data variables.product.prodname_discussions %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Move a discussion to a different category](/discussions/managing-discussions-for-your-community/managing-discussions) | {% octicon "x" aria-label="No" %} | {% ifversion discussions-moderators-control-who-can-report %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} || [Transfer a discussion](/discussions/managing-discussions-for-your-community/managing-discussions) to a new repository| {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
|
|
@ -162,7 +163,6 @@ Some of the features listed below are limited to organizations using {% data var
|
|||
| [Individually convert issues to discussions](/discussions/managing-discussions-for-your-community/moderating-discussions) | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Create new discussions and comment on existing discussions](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion) | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Delete a discussion](/discussions/managing-discussions-for-your-community/managing-discussions#deleting-a-discussion) | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {% endif %} |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
| [Create codespaces](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository?tool=webui) for private{% ifversion ghec %}/internal{% endif %} repositories | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Create codespaces](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository?tool=webui) for public repositories | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
|
|
@ -184,8 +184,9 @@ In this section, you can find the access required for security features, such as
|
|||
|
||||
| Repository action | Read | Triage | Write | Maintain | Admin |
|
||||
|:---|:---:|:---:|:---:|:---:|:---:|
|
||||
| Receive [{% data variables.product.prodname_dependabot_alerts %} for insecure dependencies](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) in a repository | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% ifversion dependabot-alerts-permissions-write-maintain %}{% octicon "check" aria-label="Yes" %}{% endif %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghes or ghec %}<!--Not available for FPT-->
|
||||
| Receive [{% data variables.product.prodname_dependabot_alerts %} for insecure dependencies](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts) in a repository | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {% ifversion ghes or ghec %}<!--Not available for FPT-->|
|
||||
| [Designate additional people or teams to receive security alerts](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |
|
||||
| {% endif %} |
|
||||
| {% ifversion fpt or ghec %} |
|
||||
|
|
|
|||
|
|
@ -29,16 +29,17 @@ When you squash and merge, {% data variables.product.prodname_dotcom %} generate
|
|||
{% else %}
|
||||
When you squash and merge, {% data variables.product.prodname_dotcom %} generates a default commit message, which you can edit. The default message depends on the number of commits in the pull request, not including merge commits.
|
||||
|
||||
Number of commits | Summary | Description |
|
||||
----------------- | ------- | ----------- |
|
||||
One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit
|
||||
More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order
|
||||
| Number of commits | Summary | Description |
|
||||
| ----------------- | ------- | ----------- |
|
||||
| One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit |
|
||||
| More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order |
|
||||
|
||||
{% endif %}
|
||||
|
||||
Number of commits | Summary | Description |
|
||||
----------------- | ------- | ----------- |
|
||||
One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit
|
||||
More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order
|
||||
| Number of commits | Summary | Description |
|
||||
| ----------------- | ------- | ----------- |
|
||||
| One commit | The title of the commit message for the single commit, followed by the pull request number | The body text of the commit message for the single commit |
|
||||
| More than one commit | The pull request title, followed by the pull request number | A list of the commit messages for all of the squashed commits, in date order |
|
||||
|
||||
{% ifversion default-merge-squash-commit-message %}
|
||||
People with maintainer or admin access to a repository can configure their repository's default merge message for all squashed commits to use the pull request title, the pull request title and commit details, or the pull request title and description. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)".{% endif %}
|
||||
|
|
|
|||
|
|
@ -64,13 +64,14 @@ You must have the proper permissions for any action to use the equivalent query
|
|||
|
||||
If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the invalid query parameters will be ignored and the rest of the URL will function as normal. If you create a URL that exceeds the server limit, the URL will return a `414 URI Too Long` error page.
|
||||
|
||||
Query parameter | Example | Valid values
|
||||
--- | --- | ---
|
||||
`name` | `https://{% data variables.product.product_url %}/new?name=test-repo&owner=avocado-corp` creates a repository called "test-repo" owned by the "avocado-corp" organization. | Any valid repository name. Spaces must be replaced with `+` or `%20`.
|
||||
`description` | `https://{% data variables.product.product_url %}/new?description=An+exciting+repository&visibility=private&owner=octocat` creates a repo with the description "An exciting repository" with private visibility owned by @octocat. | Any string. Spaces must be replaced with `+` or `%20`.
|
||||
`visibility` | `https://{% data variables.product.product_url %}/new?visibility=private` creates a repository with private visibility. | `public`<br> `private`<br>{% ifversion not fpt %}`internal`{% endif %}
|
||||
`owner` | `https://{% data variables.product.product_url %}/new?owner=avocado-corp&visibility=public` creates a public repository owned by the "avocado-corp" organization. | Any valid organization name or username. Alternatively, while signed in use `@me` to specify your user account as the owner.
|
||||
`template_owner` and `template_name` | `https://{% data variables.product.product_url %}/new?owner=avocado-corp&template_owner=avocado-corp&template_name=octo-repo` creates a repository owned by the "avocado-corp" using the avocado-corp's template "octo-repo". | The username of the template owner and the name of the repository template.
|
||||
| Query parameter | Example | Valid values |
|
||||
| --- | --- | --- |
|
||||
| `name` | `https://{% data variables.product.product_url %}/new?name=test-repo&owner=avocado-corp` creates a repository called "test-repo" owned by the "avocado-corp" organization. | Any valid repository name. Spaces must be replaced with `+` or `%20`. |
|
||||
| `description` | `https://{% data variables.product.product_url %}/new?description=An+exciting+repository&visibility=private&owner=octocat` creates a repo with the description "An exciting repository" with private visibility owned by @octocat. | Any string. Spaces must be replaced with `+` or `%20`. |
|
||||
| `visibility` | `https://{% data variables.product.product_url %}/new?visibility=private` creates a repository with private visibility. | `public`<br> `private`<br>{% ifversion not fpt %}`internal`{% endif %} |
|
||||
| `owner` | `https://{% data variables.product.product_url %}/new?owner=avocado-corp&visibility=public` creates a public repository owned by the "avocado-corp" organization. | Any valid organization name or username. Alternatively, while signed in use `@me` to specify your user account as the owner. |
|
||||
| `template_owner` and `template_name` | `https://{% data variables.product.product_url %}/new?owner=avocado-corp&template_owner=avocado-corp&template_name=octo-repo` creates a repository owned by the "avocado-corp" using the avocado-corp's template "octo-repo". | The username of the template owner and the name of the repository template. |
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
|
|
|||
|
|
@ -67,10 +67,12 @@ You can search for a discussion that has been locked using the `is` qualifier. F
|
|||
|
||||
You can filter by the visibility of the repository containing the discussions using the `is` qualifier. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)."
|
||||
|
||||
| Qualifier | Example
|
||||
| Qualifier | Example |
|
||||
| :- | :- |
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories.{% ifversion ghec %}
|
||||
| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories.{% endif %}
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Discussions) matches discussions in public repositories. |
|
||||
| {% ifversion ghec %} |
|
||||
| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Discussions) matches discussions in internal repositories. |
|
||||
| {% endif %} |
|
||||
| `is:private` | [**is:private tiramisu**](https://github.com/search?q=is%3Aprivate+tiramisu&type=Discussions) matches discussions that contain the word "tiramisu" in private repositories you can access.
|
||||
|
||||
## Search by author
|
||||
|
|
|
|||
|
|
@ -143,10 +143,12 @@ You can search repositories by the type of license in the repositories. You must
|
|||
|
||||
You can filter your search based on the visibility of the repositories. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)."
|
||||
|
||||
| Qualifier | Example
|
||||
| Qualifier | Example |
|
||||
| ------------- | ------------- |
|
||||
| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}.{% ifversion ghes or ghec %}
|
||||
| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test".{% endif %}
|
||||
| `is:public` | [**is:public org:github**](https://github.com/search?q=is%3Apublic+org%3Agithub&type=Repositories) matches public repositories owned by {% data variables.product.company_short %}. |
|
||||
| {% ifversion ghes or ghec %} |
|
||||
| `is:internal` | [**is:internal test**](https://github.com/search?q=is%3Ainternal+test&type=Repositories) matches internal repositories that you can access and contain the word "test". |
|
||||
| {% endif %} |
|
||||
| `is:private` | [**is:private pages**](https://github.com/search?q=is%3Aprivate+pages&type=Repositories) matches private repositories that you can access and contain the word "pages."
|
||||
|
||||
{% ifversion repository-properties %}
|
||||
|
|
|
|||
|
|
@ -96,10 +96,12 @@ You can filter issues based on the reason given when the issue was closed, using
|
|||
|
||||
You can filter by the visibility of the repository containing the issues and pull requests using the `is` qualifier. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#about-repository-visibility)."
|
||||
|
||||
| Qualifier | Example
|
||||
| Qualifier | Example |
|
||||
| ------------- | ------------- |
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories.{% ifversion ghes or ghec %}
|
||||
| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories.{% endif %}
|
||||
| `is:public` | [**is:public**](https://github.com/search?q=is%3Apublic&type=Issues) matches issues and pull requests in public repositories. |
|
||||
| {% ifversion ghes or ghec %} |
|
||||
| `is:internal` | [**is:internal**](https://github.com/search?q=is%3Ainternal&type=Issues) matches issues and pull requests in internal repositories. |
|
||||
| {% endif %} |
|
||||
| `is:private` | [**is:private cupcake**](https://github.com/search?q=is%3Aprivate+cupcake&type=Issues) matches issues and pull requests that contain the word "cupcake" in private repositories you can access.
|
||||
|
||||
## Search by author
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче