diff --git a/.gitignore b/.gitignore index 30492bcbc5..d610611db9 100644 --- a/.gitignore +++ b/.gitignore @@ -19,10 +19,9 @@ coverage/ blc_output.log blc_output_internal.log broken_links.md -lib/redirects/.redirects-cache.json # This one is purely for historical reasons because so many people might -# still have thes files on their disk. -lib/redirects/.redirects-cache_*.json +# still have these files on their disk. +lib/redirects/.redirects-cache*.json # During the preview deploy untrusted user code may be cloned into this directory # We ignore it from git to keep things deterministic diff --git a/assets/images/help/codespaces/disable-prebuild-optimization.png b/assets/images/help/codespaces/disable-prebuild-optimization.png new file mode 100644 index 0000000000..515b86ee6b Binary files /dev/null and b/assets/images/help/codespaces/disable-prebuild-optimization.png differ diff --git a/assets/images/help/codespaces/edit-prebuild-configuration.png b/assets/images/help/codespaces/edit-prebuild-configuration.png new file mode 100644 index 0000000000..03de0d1f31 Binary files /dev/null and b/assets/images/help/codespaces/edit-prebuild-configuration.png differ diff --git a/assets/images/help/codespaces/show-advanced-options.png b/assets/images/help/codespaces/show-advanced-options.png new file mode 100644 index 0000000000..7849d383ff Binary files /dev/null and b/assets/images/help/codespaces/show-advanced-options.png differ diff --git a/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md index 032a41910a..ef9583be44 100644 --- a/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/configuring-dependabot-alerts.md @@ -63,7 +63,7 @@ When you enable {% data variables.product.prodname_dependabot_alerts %} for exis {% ifversion fpt or ghec %}You can manage {% data variables.product.prodname_dependabot_alerts %} for your public, private or internal repository. -By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% data variables.product.product_name %} never publicly discloses insecure dependencies for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working repositories that you own or have admin permissions for. +By default, we notify people with admin permissions in the affected repositories about new {% data variables.product.prodname_dependabot_alerts %}. {% data variables.product.product_name %} never publicly discloses insecure dependencies for any repository. You can also make {% data variables.product.prodname_dependabot_alerts %} visible to additional people or teams working on repositories that you own or have admin permissions for. {% data reusables.security.security-and-analysis-features-enable-read-only %} diff --git a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 4ab4dec53c..9c44b43045 100644 --- a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -27,9 +27,7 @@ Before you can configure prebuilds for your project the following must be true: ## Configuring a prebuild -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% octicon "codespaces" aria-label="The Codespaces icon" %} {% data variables.product.prodname_codespaces %}**. +{% data reusables.codespaces.accessing-prebuild-configuration %} 1. In the "Prebuild configuration" section of the page, click **Set up prebuild**. ![The 'Set up prebuilds' button](/assets/images/help/codespaces/prebuilds-set-up.png) @@ -80,6 +78,12 @@ Before you can configure prebuilds for your project the following must be true: ![The prebuild failure notification setting](/assets/images/help/codespaces/prebuilds-failure-notification-setting.png) +1. Optionally, at the bottom of the page, click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) + + In the "Advanced options" section, if you select **Disable prebuild optimization**, codespaces will be created without a prebuild if the latest prebuild workflow has failed or is currently running. For more information, see "[Troubleshooting prebuilds](/codespaces/troubleshooting/troubleshooting-prebuilds#preventing-out-of-date-prebuilds-being-used)." + 1. Click **Create**. {% data reusables.codespaces.prebuilds-permission-authorization %} diff --git a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index 7c4b0ca4e8..45f62d023a 100644 --- a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -65,6 +65,24 @@ If the `devcontainer.json` configuration file for a prebuild configuration is up If the workflow runs for a prebuild configuration are failing, you can temporarily disable the prebuild configuration while you investigate. For more information, see "[Managing prebuilds](/codespaces/prebuilding-your-codespaces/managing-prebuilds#disabling-a-prebuild-configuration)." +### Preventing out-of-date prebuilds being used + +By default, if the latest prebuild workflow has failed, then a previous prebuild for the same combination of repository, branch, and `devcontainer.json` configuration file will be used to create new codespaces. This behavior is called prebuild optimization. + +We recommend keeping prebuild optimization enabled, because it helps ensure that codespaces can still be created quickly if an up-to-date prebuild is not available. However, as a repository administrator, you can disable prebuild optimization if you run into problems with prebuilt codespaces being behind the current state of the branch. If you disable prebuild optimization, codespaces for the relevant combination of repository, branch, and `devcontainer.json` file will be created without a prebuild if the latest prebuild workflow has failed or is currently running. + +{% data reusables.codespaces.accessing-prebuild-configuration %} +1. To the right of the affected prebuild configuration, select the ellipsis (**...**), then click **Edit**. + + ![Screenshot of a list of prebuilds, with "Edit" highlighted](/assets/images/help/codespaces/edit-prebuild-configuration.png) +1. Scroll to the bottom of the "Edit configuration" page and click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) +1. If you're sure you want to disable the default setting, select **Disable prebuild optimization**. + + ![Screenshot of the advanced option section and the "disable prebuild optmization" setting](/assets/images/help/codespaces/disable-prebuild-optimization.png) +1. To save your change, click **Update**. + ## Further reading - "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds)" diff --git a/data/reusables/codespaces/accessing-prebuild-configuration.md b/data/reusables/codespaces/accessing-prebuild-configuration.md new file mode 100644 index 0000000000..35183e342a --- /dev/null +++ b/data/reusables/codespaces/accessing-prebuild-configuration.md @@ -0,0 +1,3 @@ +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +1. In the "Code & automation" section of the sidebar, click **{% octicon "codespaces" aria-label="The Codespaces icon" %} {% data variables.product.prodname_codespaces %}**. \ No newline at end of file diff --git a/lib/redirects/static/redirect-exceptions.txt b/lib/redirects/static/redirect-exceptions.txt index 7e89add898..46149b72ef 100644 --- a/lib/redirects/static/redirect-exceptions.txt +++ b/lib/redirects/static/redirect-exceptions.txt @@ -1,8 +1,3 @@ -# Redirects are cached in 'lib/redirects/.redirects-cache.json'. If changes made here are not being reflected -# on your local server, delete the cache file by running the following command, then restart your server. -# -# rm lib/redirects/.redirects-cache.json - # These urls are exceptions to the versionless redirect fallbacks (described in lib/all-versions.js). # See the comment in lib/redirects/precompile.js for an explanation of these exceptions. # Originally shipped in pull #20947 on 10/15/21 diff --git a/middleware/api/search.js b/middleware/api/search.js index 5840f78986..34bd1426cd 100644 --- a/middleware/api/search.js +++ b/middleware/api/search.js @@ -88,10 +88,8 @@ router.get( )}-${language}` const hits = [] - const timed = statsd.asyncTimer(getSearchResults, 'api.search', [ - 'version:legacy', - `indexName:${indexName}`, - ]) + const tags = ['version:legacy', `indexName:${indexName}`] + const timed = statsd.asyncTimer(getSearchResults, 'api.search', tags) const options = { indexName, query, @@ -108,8 +106,10 @@ router.get( usePrefixSearch: true, } try { - const searchResults = await timed(options) - hits.push(...searchResults.hits) + const { hits: hits_, meta } = await timed(options) + hits.push(...hits_) + statsd.timing('api.search.total', meta.took.total_msec, tags) + statsd.timing('api.search.query', meta.took.query_msec, tags) } catch (error) { // If we don't catch here, the `catchMiddlewareError()` wrapper // will take any thrown error and pass it to `next()`. @@ -227,15 +227,16 @@ router.get( // This measurement then combines both the Node-work and the total // network-work but we know that roughly 99.5% of the total time is // spent in the network-work time so this primarily measures that. - const timed = statsd.asyncTimer(getSearchResults, 'api.search', [ - 'version:v1', - `indexName:${indexName}`, - ]) + const tags = ['version:v1', `indexName:${indexName}`] + const timed = statsd.asyncTimer(getSearchResults, 'api.search', tags) const options = { indexName, query, page, size, debug, sort } try { const { meta, hits } = await timed(options) + statsd.timing('api.search.total', meta.took.total_msec, tags) + statsd.timing('api.search.query', meta.took.query_msec, tags) + if (process.env.NODE_ENV !== 'development') { // The assumption, at the moment is that searches are never distinguished // differently depending on a cookie or a request header. diff --git a/script/move-content.js b/script/move-content.js index 46084a54f0..0ccc01ddf9 100755 --- a/script/move-content.js +++ b/script/move-content.js @@ -155,18 +155,6 @@ async function main(opts, nameTuple) { ) } } - - const redirectsCachingFile = 'lib/redirects/.redirects-cache.json' - if (fs.existsSync(redirectsCachingFile)) { - fs.unlinkSync(redirectsCachingFile) - if (verbose) { - console.log( - chalk.yellow( - `Deleted the redirects caching file ${redirectsCachingFile} to stale cache in local server testing.` - ) - ) - } - } } function validateFileInputs(oldPath, newPath, isFolder) { diff --git a/tests/fixtures/versionless-redirects.txt b/tests/fixtures/versionless-redirects.txt index 2631a91c4e..e964debc9f 100644 --- a/tests/fixtures/versionless-redirects.txt +++ b/tests/fixtures/versionless-redirects.txt @@ -1,8 +1,3 @@ -# Redirects are cached in 'lib/redirects/.redirects-cache.json'. If changes made here are not being reflected -# on your local server, delete the cache file by running the following command, then restart your server. -# -# rm lib/redirects/.redirects-cache.json - # These urls went from being free-pro-team, but are now versioned for more than one enterprise version and enterprise-cloud # Shipped in pull #20947 on 10/15/21 @@ -145,7 +140,7 @@ - /github/setting-up-and-managing-your-enterprise/configuring-identity-and-access-management-for-your-enterprise-account - /admin/authentication/managing-identity-and-access-for-your-enterprise -# These URLs went from being in free-pro-team to ONLY to being in enterprise-cloud only. +# These URLs went from being in free-pro-team to ONLY to being in enterprise-cloud only. # Shipped in pull #20947 on 10/15/21 /enterprise-cloud@latest/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise @@ -278,7 +273,7 @@ # - lib/github/private_instance_bootstrapper/internal_support_contact.rb # - lib/github/private_instance_bootstrapper/saml_idp_configuration.rb # - lib/github/private_instance_bootstrapper/policies_configuration.rb -# This redirect ensures that the links don't resolve to the non-GHAE version +# This redirect ensures that the links don't resolve to the non-GHAE version # of the docs as this article only exists in the GHAE docs. /github-ae@latest/admin/configuration/configuring-your-enterprise/initializing-github-ae diff --git a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md index 88c84fbd3b..8d2d85b673 100644 --- a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md +++ b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md @@ -1,6 +1,6 @@ --- -title: Visualizar tus suscripciones -intro: 'Para entender de dónde están llegando las notificaciones y la cantidad de las mismas, te recomendamos revisarlas frecuentemente, así como los repositorios que sigues de cerca.' +title: Viewing your subscriptions +intro: 'To understand where your notifications are coming from and your notifications volume, we recommend reviewing your subscriptions and watched repositories regularly.' redirect_from: - /articles/subscribing-to-conversations - /articles/unsubscribing-from-conversations @@ -24,63 +24,61 @@ versions: topics: - Notifications shortTitle: View subscriptions -ms.openlocfilehash: 34faad79004d34f5beb14e8992b9aff4e6a3ab39 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145117241' --- -Recibe notificaciones para sus suscripciones de la actividad reciente en {% data variables.product.product_name %}. Hay muchas razones por las cuales puedes estar suscrito a una conversación. Para obtener más información, consulte "[Acerca de las notificaciones](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)". +You receive notifications for your subscriptions of ongoing activity on {% data variables.product.product_name %}. There are many reasons you can be subscribed to a conversation. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)." -Te recomendamos auditar tus suscripciones y desuscribirte de las que no sean necesarias como parte de un flujo de trabajo de notificaciones saludable. Para obtener más información sobre las opciones para cancelar la suscripción, consulte "[Administración de suscripciones](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)". +We recommend auditing and unsubscribing from your subscriptions as a part of a healthy notifications workflow. For more information about your options for unsubscribing, see "[Managing subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." -## Diagnosticar el por qué recibes tantas notificaciones +## Diagnosing why you receive too many notifications -Cuando tu bandeja de entrada tiene demasiadas notificaciones como para administrarlas, considera si estás suscrito a más de las que puedas manejar, o cómo puedes cambiar tu configuración de notificaciones para reducir aquellas que ya tienes y ver los tipos de notificaciones que estás recibiendo. Por ejemplo, puedes considerar inhabilitar la configuración para que observes automáticamente todos los repositorios y discusiones de equipo cada que te unas a un equipo o repositorio. +When your inbox has too many notifications to manage, consider whether you have oversubscribed or how you can change your notification settings to reduce the subscriptions you have and the types of notifications you're receiving. For example, you may consider disabling the settings to automatically watch all repositories and all team discussions whenever you've joined a team or repository. -![Seguimiento automático](/assets/images/help/notifications-v2/automatic-watching-example.png) +{% ifversion update-notification-settings-22 %} +![Screenshot of automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png) +{% else %} +![Screenshot of automatic watching options for teams and repositories](/assets/images/help/notifications-v2/automatic-watching-example.png){% endif %} -Para más información, consulte "[Configuración de notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)". +For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)." -Para ver la información general de sus suscripciones a repositorios, consulte "[Revisión de los repositorios que sigue](#reviewing-repositories-that-youre-watching)". {% tip %} +To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)." +{% tip %} -**Sugerencia:** Puede seleccionar los tipos de eventos para los que quiere recibir notificaciones mediante la opción **Custom** (Personalizar) de la lista desplegable **Watch/Unwatch** (Seguir/Dejar de seguir) en la [página de seguimiento](https://github.com/watching) o en cualquier página de repositorio de {% data variables.product.product_name %}. Para más información, consulte "[Configuración de notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)". +**Tip:** You can select the types of event to be notified of by using the **Custom** option of the **Watch/Unwatch** dropdown list in your [watching page](https://github.com/watching) or on any repository page on {% data variables.product.product_name %}. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endtip %} -Muchas personas se olvidan de los repositorios que han marcado para observar. Desde la página de "Repositorios observados" puedes dejar de observar los repositorios rápidamente. Para obtener más información sobre las formas de cancelar la suscripción, consulte "[Recomendaciones para desuscribirse](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" en {% data variables.product.prodname_blog %} y "[Administración de las suscripciones](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)". También puedes crear un flujo de trabajo de clasificación para que te ayude con las notificaciones que recibes. Para obtener instrucciones sobre los flujos de trabajo de evaluación de prioridades, consulte "[Personalización de un flujo de trabajo para clasificar las notificaciones](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)". +Many people forget about repositories that they've chosen to watch in the past. From the "Watched repositories" page you can quickly unwatch repositories. For more information on ways to unsubscribe, see "[Unwatch recommendations](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" on {% data variables.product.prodname_blog %} and "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." You can also create a triage workflow to help with the notifications you receive. For guidance on triage workflows, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)." -## Revisar todas tus suscripciones +## Reviewing all of your subscriptions {% data reusables.notifications.access_notifications %} -1. En la barra lateral izquierda, en la lista de repositorios de los cuales recibe notificaciones, abra el menú desplegable "Manage notifications" (Administrar notificaciones) y haga clic en **Subscriptions** (Suscripciones). - ![Opciones del menú desplegable Manage notifications (Administrar notificaciones)](/assets/images/help/notifications-v2/manage-notifications-options.png) +1. In the left sidebar, under the list of repositories that you have notifications from, use the "Manage notifications" drop-down to click **Subscriptions**. + ![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Utiliza los filtros y organiza para reducir la lista de suscripciones y comenzar a darte de baja de las conversaciones de las cuales ya no quieres recibir notificaciones. +2. Use the filters and sort to narrow the list of subscriptions and begin unsubscribing to conversations you no longer want to receive notifications for. - ![Página de suscripciones](/assets/images/help/notifications-v2/all-subscriptions.png) + ![Subscriptions page](/assets/images/help/notifications-v2/all-subscriptions.png) {% tip %} -**Sugerencias:** -- Para revisar las suscripciones que pudiste haber olvidado, organiza por "suscripciones menos recientes" +**Tips:** +- To review subscriptions you may have forgotten about, sort by "least recently subscribed." -- Para revisar una lista de repositorios de los cuales aún puedes recibir notificaciones, despliega el menú "filtrar por repositorio" para ver el listado. +- To review a list of repositories that you can still receive notifications for, see the repository list in the "filter by repository" drop-down menu. {% endtip %} -## Revisar los repositorios que estás siguiendo de cerca +## Reviewing repositories that you're watching -1. En la barra lateral izquierda, en la lista de repositorios, use el menú desplegable "Manage notifications" (Administrar notificaciones) y haga clic en **Watched repositories** (Repositorios que sigue). - ![Opciones del menú desplegable Manage notifications (Administrar notificaciones)](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Evalúa si los repositorios que estás siguiendo de cerca tienen actualizaciones que aún sean útiles y relevantes. Cuando sigues de cerca un repositorio, se te notificará de todas las conversaciones en el mismo. -![Página de notificaciones de los repositorios que sigue](/assets/images/help/notifications-v2/watched-notifications-custom.png) +1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**. + ![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png) +2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository. +![Watched notifications page](/assets/images/help/notifications-v2/watched-notifications-custom.png) {% tip %} - **Sugerencia:** En lugar de seguir un repositorio, considere la posibilidad de recibir solo notificaciones cuando haya actualizaciones en {% data reusables.notifications-v2.custom-notification-types %} (si se han habilitado para el repositorio), o en cualquier combinación de estas opciones, o bien deje de seguir un repositorio por completo. + **Tip:** Instead of watching a repository, consider only receiving notifications when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options, or completely unwatching a repository. - Al dejar de seguir un repositorio, todavía recibirá notificaciones cuando le mencionen (@mentioned) o cuando participe en una conversación. Si configura las opciones para recibir notificaciones de ciertos tipos de eventos, solo se le notificará cuando haya actualizaciones en dichos eventos en el repositorio, cuando participe en una conversación o cuando usted o un equipo al que pertenece sean @mentioned. + When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned. {% endtip %} diff --git a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index 35d44edfe8..f0ec8c75e9 100644 --- a/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -79,15 +79,27 @@ You can customize notifications for a repository. For example, you can choose to ### Participating in conversations Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox. -For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}. +{% ifversion update-notification-settings-22 %}For conversations you're watching or participating in, you can choose whether you want to receive notifications on {% data variables.product.company_short %} or by email in your notification settings. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." + +![Animated GIF of participating and watching subscriptions options](/assets/images/help/notifications/selecting-participating-notifications.gif) + +{% else %} + +For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion ghes %} and {% data variables.product.prodname_mobile %}{% endif %}. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." + +![Screenshot of participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png){% endif %} + -![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png) For example: - If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications. - If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating". -If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates. +{% ifversion update-notification-settings-22 %}If you do not enable "Notify me: On GitHub" for watching or participating notifications, then your notifications inbox will not have any updates. + +{% else %} + +If you do not enable watching or participating notifications for web{% ifversion ghes %} and mobile{% endif %}, then your notifications inbox will not have any updates.{% endif %} ## Customizing your email notifications @@ -146,11 +158,16 @@ Email notifications from {% data variables.product.product_location %} contain t ## Automatic watching -By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options. +By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options in your notification settings. - ![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png) +{% ifversion update-notification-settings-22 %} +![Automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png) +{% else %} +![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png){% endif %} -If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. +If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. + +For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." ## Configuring your watch settings for an individual repository @@ -172,9 +189,17 @@ If you belong to an organization, you can choose the email account you want noti {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} + 3. Under "Default notification email", select the email address you'd like notifications sent to. -![Default notification email address drop-down](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) -4. Click **Save**. +{% ifversion update-notification-settings-22 %} + + ![Screenshot of the default notification email address setting](/assets/images/help/notifications/default-email-address-emphasized.png) + +{% else %} + + ![Screenshot of the default notification email address dropdown](/assets/images/help/notifications/notifications_primary_email_for_orgs.png){% endif %} +{% ifversion ghes or ghae %} +4. Click **Save**.{% endif %} ### Customizing email routes per organization @@ -182,12 +207,35 @@ If you are a member of more than one organization, you can configure each one to {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. Under "Custom routing," find your organization's name in the list. -![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) +{% ifversion update-notification-settings-22 %} +3. Under "Default notifications email", click **Custom routing**. + + ![Screenshot of default notifications email settings with custom routing button emphasised](/assets/images/help/notifications/custom-router-emphasized.png) + +4. Click **Add new route**. + + ![Screenshot of custom routing settings with add new route button emphasised](/assets/images/help/notifications/add-new-route-emphasized.png) + +5. Click **Pick organization**, then select the organization you want to customize from the dropdown. + + ![Screenshot of dropdown to pick organization](/assets/images/help/notifications/organization-dropdown-custom-routing-emphasis.png) + +6. Select one of your verified email addresses, then click **Save**. + + ![Screenshot of custom routing page with save button](/assets/images/help/notifications/select-email-address-custom-routing-and-save.png) + +{% else %} +3. Under "Custom routing," find your organization's name in the list. + + ![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) + 4. Click **Edit** next to the email address you want to change. -![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) + + ![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) + 5. Select one of your verified email addresses, then click **Save**. -![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif) + + ![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif){% endif %} ## {% data variables.product.prodname_dependabot_alerts %} notification options @@ -197,14 +245,17 @@ If you are a member of more than one organization, you can configure each one to For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts)." -{% ifversion fpt or ghes or ghec %} +{% ifversion update-notification-settings-22 or ghes %} ## {% data variables.product.prodname_actions %} notification options -Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs. +Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs.{% endif %} - ![Notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png) +{% ifversion update-notification-settings-22 %} +![Animated GIF of notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications/github-actions-customize-notifications.gif){% endif %} + +{% ifversion ghes %} + ![Screenshot of the notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png){% endif %} -{% endif %} {% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} ## Organization alerts notification options diff --git a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md index b7fc17da78..c0511693a3 100644 --- a/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md +++ b/translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md @@ -1,6 +1,6 @@ --- -title: Administrar el README de tu perfil -intro: 'Puedes agregar un README a tu perfil de {% data variables.product.prodname_dotcom %} para que otras personas sepan sobre ti.' +title: Managing your profile README +intro: 'You can add a README to your {% data variables.product.prodname_dotcom %} profile to tell other people about yourself.' versions: fpt: '*' ghes: '*' @@ -11,71 +11,67 @@ redirect_from: - /github/setting-up-and-managing-your-github-profile/managing-your-profile-readme - /github/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme shortTitle: Your profile README -ms.openlocfilehash: 587bcea1e1a0f96aad8882b41196afcc6e433363 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147578904' --- -## Acerca del README de tu perfil +## About your profile README -Puede compartir información acerca de usted mismo con la comunidad en {% data variables.product.product_location %} si crea un README del perfil. {% data variables.product.prodname_dotcom %} muestra el README de tu perfil al inicio de tu página de perfil. +You can share information about yourself with the community on {% data variables.product.product_location %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page. -Tú decides qué información incluir en el README de tu perfil, así que tienes todo el contro sobre cómo te presentas con los demás en {% data variables.product.prodname_dotcom %}. Aquí tienes algunos ejemplos de información que puede ser interesante, divertida o útil para los visitantes que lean el README en tu perfil. +You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README. -- Una sección de "sobre mí" que describa tu trabajo y tus intereses -- Las contribuciones de las cuales estás orgulloso y el contexto de las mismas -- Orientación para obtener ayuda en las comunidades en las que estás involucrado +- An "About me" section that describes your work and interests +- Contributions you're proud of, and context about those contributions +- Guidance for getting help in communities where you're involved -![Archivo de README del perfil que se muestra en éste](/assets/images/help/repository/profile-with-readme.png) +![Profile README file displayed on profile](/assets/images/help/repository/profile-with-readme.png) -Puedes formatear el texto e incluir emojis, imágenes y GIFs en el README de tu perfil si utilizas el Marcado Enriquecido de {% data variables.product.company_short %}. Para obtener más información, consulte "[Introducción a la escritura y el formato en {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)". +You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)." For a hands-on guide to customizing your profile README, see "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)." -## Prerrequisitos +## Prerequisites -GitHub mostrará el README de tu perfil en tu página de perfil si cuentas con todo lo siguiente. +GitHub will display your profile README on your profile page if all of the following are true. -- Has creado un repositorio con un nombre que empate con tu nombre de usuario de {% data variables.product.prodname_dotcom %}. -- Este repositorio es público. -- Este repositorio contiene un archivo de nombre README.md en su raíz. -- El archivo README.md contiene cualquier tipo de contenido. +- You've created a repository with a name that matches your {% data variables.product.prodname_dotcom %} username. +- The repository is public. +- The repository contains a file named README.md in its root. +- The README.md file contains any content. {% note %} -**Nota**: Si creó un repositorio público con el mismo nombre que su nombre de usuario antes de julio del 2020, {% data variables.product.prodname_dotcom %} no mostrará automáticamente el README del repositorio en su perfil. Puede compartir manualmente el README del repositorio en su perfil. Para ello, vaya al repositorio en {% data variables.product.prodname_dotcom_the_website %} y haga clic en **Share to profile**. +**Note**: If you created a public repository with the same name as your username before July 2020, {% data variables.product.prodname_dotcom %} won't automatically show the repository's README on your profile. You can manually share the repository's README to your profile by going to the repository on {% data variables.product.prodname_dotcom_the_website %} and clicking **Share to profile**. -![Botón para compartir el README en el perfil](/assets/images/help/repository/share-to-profile.png) +![Button to share README to profile](/assets/images/help/repository/share-to-profile.png) {% endnote %} -## Agregar un README de perfil +## Adding a profile README {% data reusables.repositories.create_new %} -2. Debajo de "Nombre de repositorio", teclea un nombre de repositorio que empate con tu nombre de usuario de {% data variables.product.prodname_dotcom %}. Por ejemplo, si tu nombre de usuario es "octocat", el nombre de repositorio debe ser "octocat". - ![Campo de nombre de repositorio que coincide con el nombre de usuario](/assets/images/help/repository/repo-username-match.png) -3. Opcionalmente, puede agregar una descripción del repositorio. Por ejemplo, "Mi repositorio personal". - ![Campo para introducir una descripción para el repositorio](/assets/images/help/repository/create-personal-repository-desc.png) -4. Seleccione **Público**. - ![Botón de radio para seleccionar la visibilidad con la opción Public seleccionada](/assets/images/help/repository/create-personal-repository-visibility.png) {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -7. Encima de la barra lateral derecha, haga clic en **Edit README**. - ![Botón para editar el archivo README](/assets/images/help/repository/personal-repository-edit-readme.png) +2. Under "Repository name", type a repository name that matches your {% data variables.product.prodname_dotcom %} username. For example, if your username is "octocat", the repository name must be "octocat". + ![Repository name field which matches username](/assets/images/help/repository/repo-username-match.png) +3. Optionally, add a description of your repository. For example, "My personal repository." + ![Field for entering a repository description](/assets/images/help/repository/create-personal-repository-desc.png) +4. Select **Public**. + ![Radio button to select visibility with public selected](/assets/images/help/repository/create-personal-repository-visibility.png) +{% data reusables.repositories.initialize-with-readme %} +{% data reusables.repositories.create-repo %} +7. Above the right sidebar, click **Edit README**. + ![Button to edit README file](/assets/images/help/repository/personal-repository-edit-readme.png) - El archivo de README que se ha generado está pre-llenado con una plantilla para que te inspires en completarlo. - ![Archivo README con la plantilla completada previamente](/assets/images/help/repository/personal-repository-readme-template.png) + The generated README file is pre-populated with a template to give you some inspiration for your profile README. + ![README file with pre-populated template](/assets/images/help/repository/personal-repository-readme-template.png) -Para obtener un resumen de todos los emojis disponibles y sus códigos, consulte "[Hoja de referencia rápida de emoji](https://www.webfx.com/tools/emoji-cheat-sheet/)". +For a summary of all the available emojis and their codes, see "[Emoji cheat sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)." -## Eliminar un README de perfil +## Removing a profile README -El README de tu perfil se eliminará de tu perfil de {% data variables.product.prodname_dotcom %} si sucede cualquiera de los siguientes escenarios: +The profile README is removed from your {% data variables.product.prodname_dotcom %} profile if any of the following apply: -- El archivo README está vacío o no existe. -- El repositorio es privado. -- El nombre del repositorio no empata con tu nombre de usuario. +- The README file is empty or doesn't exist. +- The repository is private. +- The repository name no longer matches your username. -The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. Para ver los pasos para hacer un repositorio privado, consulta "[Cambiar la visibilidad de un repositorio](/github/administering-a-repository/setting-repository-visibility#changing-a-repositorys-visibility)". +The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see "[Changing a repository's visibility](/github/administering-a-repository/setting-repository-visibility#changing-a-repositorys-visibility)." -## Información adicional +## Further reading -- "[Acerca de los archivos README](/github/creating-cloning-and-archiving-repositories/about-readmes)" +- [About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes) diff --git a/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md b/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md index 6a56652420..66fc48555f 100644 --- a/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md +++ b/translations/es-ES/content/actions/creating-actions/creating-a-javascript-action.md @@ -1,5 +1,6 @@ --- title: Creating a JavaScript action +shortTitle: Create a JavaScript action intro: 'In this guide, you''ll learn how to build a JavaScript action using the actions toolkit.' redirect_from: - /articles/creating-a-javascript-action @@ -15,7 +16,6 @@ type: tutorial topics: - Action development - JavaScript -shortTitle: JavaScript action --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md index 8aa0aa6a7f..40a00cfb3f 100644 --- a/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md +++ b/translations/es-ES/content/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect.md @@ -1,6 +1,6 @@ --- title: About security hardening with OpenID Connect -shortTitle: About security hardening with OpenID Connect +shortTitle: Security hardening with OpenID Connect intro: OpenID Connect allows your workflows to exchange short-lived tokens directly from your cloud provider. miniTocMaxHeadingLevel: 4 versions: diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/translations/es-ES/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 053f0e3d1e..89ba5d874e 100644 --- a/translations/es-ES/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/translations/es-ES/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -1,5 +1,6 @@ --- title: Autoscaling with self-hosted runners +shortTitle: Autoscale self-hosted runners intro: You can automatically scale your self-hosted runners in response to webhook events. versions: fpt: '*' @@ -63,7 +64,7 @@ By default, self-hosted runners will automatically perform a software update whe To turn off automatic software updates and install software updates yourself, specify the `--disableupdate` flag when registering your runner using `config.sh`. For example: ```shell -./config.sh --url https://github.com/octo-org --token example-token --disableupdate +./config.sh --url https://github.com/YOUR-ORGANIZATION --token EXAMPLE-TOKEN --disableupdate ``` If you disable automatic updates, you must still update your runner version regularly. New functionality in {% data variables.product.prodname_actions %} requires changes in both the {% data variables.product.prodname_actions %} service _and_ the runner software. The runner may not be able to correctly process jobs that take advantage of new features in {% data variables.product.prodname_actions %} without a software update. diff --git a/translations/es-ES/content/actions/learn-github-actions/contexts.md b/translations/es-ES/content/actions/learn-github-actions/contexts.md index a4fdab860d..7a13b15687 100644 --- a/translations/es-ES/content/actions/learn-github-actions/contexts.md +++ b/translations/es-ES/content/actions/learn-github-actions/contexts.md @@ -201,7 +201,7 @@ The `github` context contains information about the workflow run and the event t | `github.ref` | `string` | {% data reusables.actions.ref-description %} | {%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} | `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} | -| `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} | +| `github.ref_protected` | `boolean` | {% data reusables.actions.ref_protected-description %} | | `github.ref_type` | `string` | {% data reusables.actions.ref_type-description %} | {%- endif %} | `github.path` | `string` | Path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-commands-for-github-actions#adding-a-system-path)." | diff --git a/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md b/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md index 8569d3cf80..26a3fa7743 100644 --- a/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/translations/es-ES/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -1,6 +1,6 @@ --- title: Finding and customizing actions -shortTitle: Finding and customizing actions +shortTitle: Find and customize actions intro: 'Actions are the building blocks that power your workflow. A workflow can contain actions created by the community, or you can create your own actions directly within your application''s repository. This guide will show you how to discover, use, and customize actions.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-github-marketplace-actions diff --git a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md index f3c1c1faf6..da677ef353 100644 --- a/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/es-ES/content/actions/learn-github-actions/understanding-github-actions.md @@ -1,6 +1,6 @@ --- title: Understanding GitHub Actions -shortTitle: Understanding GitHub Actions +shortTitle: Understand GitHub Actions intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.' miniTocMaxHeadingLevel: 3 redirect_from: @@ -87,15 +87,9 @@ For more information, see "[Creating actions](/actions/creating-actions)." {% data reusables.actions.workflow-basic-example-and-explanation %} -## More complex examples -{% data reusables.actions.link-to-example-library %} - ## Next steps -- To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." -{% ifversion fpt or ghec or ghes %} -- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." -{% endif %} +{% data reusables.actions.onboarding-next-steps %} ## Contacting support diff --git a/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md b/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md index cc2359f7a5..2984bbaf48 100644 --- a/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md +++ b/translations/es-ES/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md @@ -1,5 +1,6 @@ --- title: Re-running workflows and jobs +shortTitle: Re-run workflows and jobs intro: 'You can re-run a workflow run{% ifversion re-run-jobs %}, all failed jobs in a workflow run, or specific jobs in a workflow run{% endif %} up to 30 days after its initial run.' permissions: People with write permissions to a repository can re-run workflows in the repository. miniTocMaxHeadingLevel: 3 @@ -48,14 +49,14 @@ Re-running a workflow{% ifversion re-run-jobs %} or jobs in a workflow{% endif % To re-run a failed workflow run, use the `run rerun` subcommand. Replace `run-id` with the ID of the failed run that you want to re-run. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id +gh run rerun RUN_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --debug +gh run rerun RUN_ID --debug ``` {% endif %} @@ -90,14 +91,14 @@ If any jobs in a workflow run failed, you can re-run just the jobs that failed. To re-run failed jobs in a workflow run, use the `run rerun` subcommand with the `--failed` flag. Replace `run-id` with the ID of the run for which you want to re-run failed jobs. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id --failed +gh run rerun RUN_ID --failed ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --failed --debug +gh run rerun RUN_ID --failed --debug ``` {% endif %} @@ -127,14 +128,14 @@ When you re-run a specific job in a workflow, a new workflow run will start for To re-run a specific job in a workflow run, use the `run rerun` subcommand with the `--job` flag. Replace `job-id` with the ID of the job that you want to re-run. ```shell -gh run rerun --job job-id +gh run rerun --job JOB_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun --job job-id --debug +gh run rerun --job JOB_ID --debug ``` {% endif %} diff --git a/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md b/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md index c56906a838..8f521c2664 100644 --- a/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md +++ b/translations/es-ES/content/actions/publishing-packages/publishing-docker-images.md @@ -1,5 +1,6 @@ --- title: Publishing Docker images +shortTitle: Publish Docker images intro: 'You can publish Docker images to a registry, such as Docker Hub or {% data variables.product.prodname_registry %}, as part of your continuous integration (CI) workflow.' redirect_from: - /actions/language-and-framework-guides/publishing-docker-images diff --git a/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md index 0768413dbc..908764eb17 100644 --- a/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/es-ES/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -1,5 +1,6 @@ --- title: Publishing Node.js packages +shortTitle: Publish Node.js packages intro: You can publish Node.js packages to a registry as part of your continuous integration (CI) workflow. redirect_from: - /actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages @@ -16,7 +17,6 @@ topics: - Publishing - Node - JavaScript -shortTitle: Node.js packages --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/es-ES/content/actions/quickstart.md b/translations/es-ES/content/actions/quickstart.md index b83df0ebe2..44f3ab36a3 100644 --- a/translations/es-ES/content/actions/quickstart.md +++ b/translations/es-ES/content/actions/quickstart.md @@ -77,21 +77,13 @@ Committing the workflow file to a branch in your repository triggers the `push` For example, you can see the list of files in your repository: ![Example action detail](/assets/images/help/repository/actions-quickstart-log-detail.png) - + +The example workflow you just added is triggered each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. For an in-depth tutorial, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)." + ## More starter workflows {% data reusables.actions.workflow-template-overview %} -## More complex examples -{% data reusables.actions.link-to-example-library %} - ## Next steps -The example workflow you just added runs each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. But this is only the beginning of what you can do with {% data variables.product.prodname_actions %}: - -- Your repository can contain multiple workflows that trigger different jobs based on different events. -- You can use a workflow to install software testing apps and have them automatically test your code on {% data variables.product.prodname_dotcom %}'s runners. - -{% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}: - -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial. +{% data reusables.actions.onboarding-next-steps %} diff --git a/translations/es-ES/content/actions/security-guides/encrypted-secrets.md b/translations/es-ES/content/actions/security-guides/encrypted-secrets.md index 9a60fda43d..e678c2474c 100644 --- a/translations/es-ES/content/actions/security-guides/encrypted-secrets.md +++ b/translations/es-ES/content/actions/security-guides/encrypted-secrets.md @@ -93,13 +93,13 @@ If your repository has environment secrets or can access secrets from the parent To add a repository secret, use the `gh secret set` subcommand. Replace `secret-name` with the name of your secret. ```shell -gh secret set secret-name +gh secret set SECRET_NAME ``` The CLI will prompt you to enter a secret value. Alternatively, you can read the value of the secret from a file. ```shell -gh secret set secret-name < secret.txt +gh secret set SECRET_NAME < secret.txt ``` To list all secrets for the repository, use the `gh secret list` subcommand. @@ -128,13 +128,13 @@ To list all secrets for the repository, use the `gh secret list` subcommand. To add a secret for an environment, use the `gh secret set` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret set --env environment-name secret-name +gh secret set --env ENV_NAME SECRET_NAME ``` To list all secrets for an environment, use the `gh secret list` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret list --env environment-name +gh secret list --env ENV_NAME ``` {% endcli %} @@ -173,25 +173,25 @@ gh auth login --scopes "admin:org" To add a secret for an organization, use the `gh secret set` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret set --org organization-name secret-name +gh secret set --org ORG_NAME SECRET_NAME ``` By default, the secret is only available to private repositories. To specify that the secret should be available to all repositories within the organization, use the `--visibility` or `-v` flag. ```shell -gh secret set --org organization-name secret-name --visibility all +gh secret set --org ORG_NAME SECRET_NAME --visibility all ``` To specify that the secret should be available to selected repositories within the organization, use the `--repos` or `-r` flag. ```shell -gh secret set --org organization-name secret-name --repos repo-name-1,repo-name-2" +gh secret set --org ORG_NAME SECRET_NAME --repos REPO-NAME-1, REPO-NAME-2" ``` To list all secrets for an organization, use the `gh secret list` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret list --org organization-name +gh secret list --org ORG_NAME ``` {% endcli %} diff --git a/translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md b/translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md index 17fb1a7a0f..e3251b78a6 100644 --- a/translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md +++ b/translations/es-ES/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -1,11 +1,11 @@ --- title: Using larger runners +shortTitle: 'Larger runners' intro: '{% data variables.product.prodname_dotcom %} offers larger runners with more RAM and CPU.' miniTocMaxHeadingLevel: 3 product: '{% data reusables.gated-features.hosted-runners %}' versions: feature: 'actions-hosted-runners' -shortTitle: Using {% data variables.actions.hosted_runner %}s --- ## Overview of {% data variables.actions.hosted_runner %}s @@ -87,7 +87,7 @@ You can add a {% data variables.actions.hosted_runner %} to an organization, whe ## Running jobs on your runner -Once your runner type has been been defined, you can update your workflows to send jobs to the runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: +Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: ```yaml name: learn-github-actions @@ -104,6 +104,8 @@ jobs: - run: bats -v ``` +To find out which runners are enabled for your repository and organization, you must contact your organization admin. Your organization admin can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. + ## Managing access to your runners {% note %} diff --git a/translations/es-ES/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md b/translations/es-ES/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md index 77dd9af5bf..ad1fc32d99 100644 --- a/translations/es-ES/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md +++ b/translations/es-ES/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md @@ -1,6 +1,6 @@ --- title: Creating starter workflows for your organization -shortTitle: Creating starter workflows +shortTitle: Create starter workflows intro: Learn how you can create starter workflows to help people in your team add new workflows more easily. redirect_from: - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization diff --git a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md index 432b32ff8a..016cb10829 100644 --- a/translations/es-ES/content/actions/using-workflows/reusing-workflows.md +++ b/translations/es-ES/content/actions/using-workflows/reusing-workflows.md @@ -1,6 +1,6 @@ --- title: Reusing workflows -shortTitle: Reusing workflows +shortTitle: Reuse workflows intro: Learn how to avoid duplication when creating a workflow by reusing existing workflows. redirect_from: - /actions/learn-github-actions/reusing-workflows @@ -105,7 +105,7 @@ You can define inputs and secrets, which can be passed from the caller workflow on: workflow_call: inputs: - username: + config-path: required: true type: string secrets: @@ -133,10 +133,10 @@ You can define inputs and secrets, which can be passed from the caller workflow runs-on: ubuntu-latest environment: production steps: - - uses: octo-org/my-action@v1 - with: - username: ${{ inputs.username }} - token: ${{ secrets.envPAT }} + - uses: actions/labeler@v4 + with: + repo-token: ${{ secrets.envPAT }} + configuration-path: ${{ inputs.config-path }} ``` {% endraw %} In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job. @@ -162,7 +162,7 @@ name: Reusable workflow example on: workflow_call: inputs: - username: + config-path: required: true type: string secrets: @@ -170,14 +170,13 @@ on: required: true jobs: - example_job: - name: Pass input and secrets to my-action + triage: runs-on: ubuntu-latest steps: - - uses: octo-org/my-action@v1 - with: - username: ${{ inputs.username }} - token: ${{ secrets.token }} + - uses: actions/labeler@v4 + with: + repo-token: ${{ secrets.token }} + configuration-path: ${{ inputs.config-path }} ``` {% endraw %} @@ -256,7 +255,7 @@ When you call a reusable workflow, you can only use the following keywords in th ### Example caller workflow -This workflow file calls two workflow files. The second of these, `workflow-B.yml` (shown in the [example reusable workflow](#example-reusable-workflow)), is passed an input (`username`) and a secret (`token`). +This workflow file calls two workflow files. The second of these, `workflow-B.yml` (shown in the [example reusable workflow](#example-reusable-workflow)), is passed an input (`config-path`) and a secret (`token`). {% raw %} ```yaml{:copy} @@ -272,11 +271,14 @@ jobs: uses: octo-org/example-repo/.github/workflows/workflow-A.yml@v1 call-workflow-passing-data: + permissions: + contents: read + pull-requests: write uses: octo-org/example-repo/.github/workflows/workflow-B.yml@main with: - username: mona + config-path: .github/labeler.yml secrets: - token: ${{ secrets.TOKEN }} + token: ${{ secrets.GITHUB_TOKEN }} ``` {% endraw %} diff --git a/translations/es-ES/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md b/translations/es-ES/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md index 2109206f82..6d56152317 100644 --- a/translations/es-ES/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md +++ b/translations/es-ES/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md @@ -1,6 +1,6 @@ --- title: 'Sharing workflows, secrets, and runners with your organization' -shortTitle: Sharing workflows with your organization +shortTitle: Share workflows with your organization intro: 'Learn how you can use organization features to collaborate with your team, by sharing starter workflows, secrets, and self-hosted runners.' redirect_from: - /actions/learn-github-actions/sharing-workflows-with-your-organization diff --git a/translations/es-ES/content/actions/using-workflows/triggering-a-workflow.md b/translations/es-ES/content/actions/using-workflows/triggering-a-workflow.md index 9c19cc72ff..c0c7429ee7 100644 --- a/translations/es-ES/content/actions/using-workflows/triggering-a-workflow.md +++ b/translations/es-ES/content/actions/using-workflows/triggering-a-workflow.md @@ -1,6 +1,6 @@ --- title: Triggering a workflow -shortTitle: Triggering a workflow +shortTitle: Trigger a workflow intro: 'How to automatically trigger {% data variables.product.prodname_actions %} workflows' versions: fpt: '*' diff --git a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 26c878bfaa..6f6735949d 100644 --- a/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -93,7 +93,7 @@ By default, the rate limit for {% data variables.product.prodname_actions %} is ```shell ghe-config actions-rate-limiting.enabled true - ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE + ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE ``` 1. To disable the rate limit after it's been enabled, run the following command. diff --git a/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index 2fabe7244a..590bf709b2 100644 --- a/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -118,7 +118,7 @@ If the upgrade target you're presented with is a feature release instead of a pa {% data reusables.enterprise_installation.download-package %} 4. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg *** verifying upgrade package signature... ``` 5. If a reboot is required for updates for kernel, MySQL, Elasticsearch or other programs, the hotpatch upgrade script notifies you. @@ -170,14 +170,14 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea 5. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg *** verifying upgrade package signature... ``` 6. Confirm that you'd like to continue with the upgrade and restart after the package signature verifies. The new root filesystem writes to the secondary partition and the instance automatically restarts in maintenance mode: ```shell *** applying update... - This package will upgrade your installation to version version-number - Current root partition: /dev/xvda1 [version-number] + This package will upgrade your installation to version VERSION-NUMBER + Current root partition: /dev/xvda1 [VERSION-NUMBER] Target root partition: /dev/xvda2 Proceed with installation? [y/N] ``` diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 725276d46d..47804fb2d7 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Streaming del registro de auditoría de su empresa -intro: 'Puedes trasmitir datos de eventos de Git y de auditorías desde {% data variables.product.prodname_dotcom %} hacia un sistema externo de administración de datos.' +title: Streaming the audit log for your enterprise +intro: 'You can stream audit and Git events data from {% data variables.product.prodname_dotcom %} to an external data management system.' miniTocMaxHeadingLevel: 3 versions: feature: audit-log-streaming @@ -15,34 +15,32 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/streaming-the-audit-logs-for-organizations-in-your-enterprise-account - /admin/user-management/managing-organizations-in-your-enterprise/streaming-the-audit-logs-for-organizations-in-your-enterprise-account permissions: Enterprise owners can configure audit log streaming. -ms.openlocfilehash: 81eb88f760016390a321798589e7994542c9f312 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147710343' --- -{% ifversion ghes %} {% note %} -**Nota:** La transmisión de registros de auditoría se encuentra actualmente en beta para {% data variables.product.product_name %} y está sujeta a cambios. +{% ifversion ghes %} +{% note %} -{% endnote %} {% endif %} +**Note:** Audit log streaming is currently in beta for {% data variables.product.product_name %} and is subject to change. -## Acerca de la transmisión de bitácoras de auditoría +{% endnote %} +{% endif %} -Para ayudar a proteger la propiedad intelectual y mantener el cumplimiento de su organización, puede usar streaming para conservar copias de los datos del registro de auditoría y supervisar: {% data reusables.audit_log.audited-data-list %} +## About audit log streaming -Los beneficios de transmitir datos de auditoría incluyen: +To help protect your intellectual property and maintain compliance for your organization, you can use streaming to keep copies of your audit log data and monitor: +{% data reusables.audit_log.audited-data-list %} -* **Exploración de datos**. Puedes examinar los eventos transmitidos utilizando tu herramienta preferida para consultar cantidades grandes de datos. La transmisión contiene tanto los eventos de auditoría como los de Git a lo largo de toda la cuenta empresarial.{% ifversion pause-audit-log-stream %} -* **Continuidad de los datos**. Puedes poner en pausa la transmisión un máximo de siete días sin perder datos de auditoría.{% endif %} -* **Retención de datos**. Puede mantener los registros de auditoría exportados y los datos de eventos de Git siempre que sea necesario. +The benefits of streaming audit data include: -Los propietarios de la empresa pueden configurar{% ifversion pause-audit-log-stream %}, poner en pausa{% endif %} o eliminar una secuencia en cualquier momento. La transmisión exporta los datos de eventos de Git y auditoría de todas las organizaciones en tu empresa. +* **Data exploration**. You can examine streamed events using your preferred tool for querying large quantities of data. The stream contains both audit events and Git events across the entire enterprise account.{% ifversion pause-audit-log-stream %} +* **Data continuity**. You can pause the stream for up to seven days without losing any audit data.{% endif %} +* **Data retention**. You can keep your exported audit logs and Git events data as long as you need to. -## Configurar la transmisión de bitácoras de auditoría +Enterprise owners can set up{% ifversion pause-audit-log-stream %}, pause,{% endif %} or delete a stream at any time. The stream exports the audit and Git events data for all of the organizations in your enterprise. -Puedes configurar la transmisión de bitácoras de auditoría en {% data variables.product.product_name %} si sigues las instrucciones para tu proveedor. +## Setting up audit log streaming + +You set up the audit log stream on {% data variables.product.product_name %} by following the instructions for your provider. - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) @@ -51,52 +49,49 @@ Puedes configurar la transmisión de bitácoras de auditoría en {% data variabl - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) -### Configurar la transmisión para Amazon S3 - -{% ifversion streaming-oidc-s3 %} Puedes configurar la transmisión a S3 con claves de acceso o bien, para evitar almacenar secretos de larga duración en {% data variables.product.product_name %}, con OpenID Connect (OIDC). - -- [Configuración de la transmisión a S3 con claves de acceso](#setting-up-streaming-to-s3-with-access-keys) -- [Configuración de la transmisión a S3 con OpenID Connect](#setting-up-streaming-to-s3-with-openid-connect) -- [Deshabilitación de la transmisión a S3 con OpenID Connect](#disabling-streaming-to-s3-with-openid-connect) - -#### Configuración de la transmisión a S3 con claves de acceso -{% endif %} - -Para transmitir bitácoras de auditoría a la terminal de Amazon S3, debes tener un bucket y llaves de acceso. Para obtener más información, consulta [Creación, configuración y trabajo con buckets de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) en la documentación de AWS. Asegúrate de bloquear el acceso público al bucket para proteger la información de tu bitácora de auditoría. - -Para configurar la transmisión de bitácora de auditoría desde {% data variables.product.prodname_dotcom %}, necesitarás: -* El nombrede tu bucket de Amazon S3 -* Tu ID de llave de acceso de AWS -* Tu llave de secreto de AWS - -Para obtener información sobre cómo crear o acceder al id. clave de acceso y la clave secreta, vea [Comprender y obtener las credenciales de AWS](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html) en la documentación de AWS. - -{% data reusables.enterprise.navigate-to-log-streaming-tab %} {% data reusables.audit_log.streaming-choose-s3 %}{% ifversion streaming-oidc-s3 %} -1. En "Autenticación", haz clic en **Claves de acceso**. - - ![Captura de pantalla de las opciones de autenticación para la transmisión a Amazon S3](/assets/images/help/enterprises/audit-log-streaming-s3-access-keys.png){% endif %} -1. Configura los valores de transmisión. - - - En "Cubo", escribe el nombre del cubo al que quieres transmitir. Por ejemplo, `auditlog-streaming-test`. - - En "Id. de clave de acceso", escribe el identificador de la clave de acceso. Por ejemplo, `ABCAIOSFODNN7EXAMPLE1`. - - En "Clave secreta", escribe la clave secreta. Por ejemplo, `aBcJalrXUtnWXYZ/A1MDENG/zPxRfiCYEXAMPLEKEY`. -{% data reusables.audit_log.streaming-check-s3-endpoint %} {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +### Setting up streaming to Amazon S3 {% ifversion streaming-oidc-s3 %} -#### Configuración de la transmisión a S3 con OpenID Connect +You can set up streaming to S3 with access keys or, to avoid storing long-lived secrets in {% data variables.product.product_name %}, with OpenID Connect (OIDC). -{% note %} +- [Setting up streaming to S3 with access keys](#setting-up-streaming-to-s3-with-access-keys) +- [Setting up streaming to S3 with OpenID Connect](#setting-up-streaming-to-s3-with-openid-connect) +- [Disabling streaming to S3 with OpenID Connect](#disabling-streaming-to-s3-with-openid-connect) -**Nota:** El streaming a Amazon S3 con OpenID Connect está actualmente en versión beta y está sujeto a cambios. +#### Setting up streaming to S3 with access keys +{% endif %} -{% endnote %} +To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. -1. En AWS, agrega el proveedor de OIDC de {% data variables.product.prodname_dotcom %} a IAM. Para obtener más información, consulta [Creación de proveedores de identidades de OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) en la documentación de AWS. +To set up audit log streaming from {% data variables.product.prodname_dotcom %} you will need: +* The name of your Amazon S3 bucket +* Your AWS access key ID +* Your AWS secret key - - Para la dirección URL del proveedor, usa `https://oidc-configuration.audit-log.githubusercontent.com`. - - Para "Audiencia", usa `sts.amazonaws.com`. -1. Crea un cubo y bloquea el acceso público a él. Para obtener más información, consulta [Creación, configuración y trabajo con buckets de Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) en la documentación de AWS. -1. Crea una directiva que permita que {% data variables.product.company_short %} escriba en el cubo. {% data variables.product.prodname_dotcom %} solo requiere los permisos siguientes. +For information on creating or accessing your access key ID and secret key, see [Understanding and getting your AWS credentials](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html) in the AWS documentation. + +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +{% data reusables.audit_log.streaming-choose-s3 %}{% ifversion streaming-oidc-s3 %} +1. Under "Authentication", click **Access keys**. + + ![Screenshot of the authentication options for streaming to Amazon S3](/assets/images/help/enterprises/audit-log-streaming-s3-access-keys.png){% endif %} +1. Configure the stream settings. + + - Under "Bucket", type the name of the bucket you want to stream to. For example, `auditlog-streaming-test`. + - Under "Access Key ID", type your access key ID. For example, `ABCAIOSFODNN7EXAMPLE1`. + - Under "Secret Key", type your secret key. For example, `aBcJalrXUtnWXYZ/A1MDENG/zPxRfiCYEXAMPLEKEY`. +{% data reusables.audit_log.streaming-check-s3-endpoint %} +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} + +{% ifversion streaming-oidc-s3 %} +#### Setting up streaming to S3 with OpenID Connect + +1. In AWS, add the {% data variables.product.prodname_dotcom %} OIDC provider to IAM. For more information, see [Creating OpenID Connect (OIDC) identity providers](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) in the AWS documentation. + + - For the provider URL, use `https://oidc-configuration.audit-log.githubusercontent.com`. + - For "Audience", use `sts.amazonaws.com`. +1. Create a bucket, and block public access to the bucket. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. +1. Create a policy that allows {% data variables.product.company_short %} to write to the bucket. {% data variables.product.prodname_dotcom %} requires only the following permissions. ``` { @@ -113,11 +108,11 @@ Para obtener información sobre cómo crear o acceder al id. clave de acceso y l ] } ``` - Para obtener más información, consulta [Crear políticas de IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) en la documentación de AWS. -1. Configura el rol y la directiva de confianza para el IdP de {% data variables.product.prodname_dotcom %}. Para obtener más información, consulta [Creación de un rol para identidades federadas web u OpenID Connect (consola)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html) en la documentación de AWS. + For more information, see [Creating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the AWS documentation. +1. Configure the role and trust policy for the {% data variables.product.prodname_dotcom %} IdP. For more information, see [Creating a role for web identity or OpenID Connect Federation (console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html) in the AWS documentation. - - Agrega la directiva de permisos que creaste anteriormente para permitir operaciones de escritura en el cubo. - - Edita la relación de confianza para agregar el campo `sub` a las condiciones de validación. Reemplaza `ENTERPRISE` por el nombre de la empresa. + - Add the permissions policy you created above to allow writes to the bucket. + - Edit the trust relationship to add the `sub` field to the validation conditions, replacing `ENTERPRISE` with the name of your enterprise. ``` "Condition": { "StringEquals": { @@ -126,209 +121,217 @@ Para obtener información sobre cómo crear o acceder al id. clave de acceso y l } } ``` - - Anota el nombre de recurso de Amazon (ARN) del rol creado. -{% data reusables.enterprise.navigate-to-log-streaming-tab %} {% data reusables.audit_log.streaming-choose-s3 %} -1. En "Autenticación", haz clic en **OpenID Connect**. + - Make note of the Amazon Resource Name (ARN) of the created role. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +{% data reusables.audit_log.streaming-choose-s3 %} +1. Under "Authentication", click **OpenID Connect**. - ![Captura de pantalla de las opciones de autenticación para la transmisión a Amazon S3](/assets/images/help/enterprises/audit-log-streaming-s3-oidc.png) -1. Configura los valores de transmisión. + ![Screenshot of the authentication options for streaming to Amazon S3](/assets/images/help/enterprises/audit-log-streaming-s3-oidc.png) +1. Configure the stream settings. - - En "Cubo", escribe el nombre del cubo al que quieres transmitir. Por ejemplo, `auditlog-streaming-test`. - - En "Rol de ARN", escribe el rol de ARN que anotaste anteriormente. Por ejemplo, `arn:aws::iam::1234567890:role/github-audit-log-streaming-role`. -{% data reusables.audit_log.streaming-check-s3-endpoint %} {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} + - Under "Bucket", type the name of the bucket you want to stream to. For example, `auditlog-streaming-test`. + - Under "ARN Role" type the ARN role you noted earlier. For example, `arn:aws::iam::1234567890:role/github-audit-log-streaming-role`. +{% data reusables.audit_log.streaming-check-s3-endpoint %} +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -#### Deshabilitación de la transmisión a S3 con OpenID Connect +#### Disabling streaming to S3 with OpenID Connect -Si deseas deshabilitar la transmisión a S3 con OIDC por cualquier motivo, como la detección de una vulnerabilidad de seguridad en OIDC, elimina el proveedor de OIDC {% data variables.product.prodname_dotcom %} que creaste en AWS al configurar la transmisión. Para obtener más información, consulta [Creación de proveedores de identidades de OpenID Connect (OIDC)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) en la documentación de AWS. +If you want to disable streaming to S3 with OIDC for any reason, such as the discovery of a security vulnerability in OIDC, delete the {% data variables.product.prodname_dotcom %} OIDC provider you created in AWS when you set up streaming. For more information, see [Creating OpenID Connect (OIDC) identity providers](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) in the AWS documentation. -A continuación, configura la transmisión con claves de acceso hasta que se resuelva la vulnerabilidad. Para obtener más información, consulta "[Configuración de la transmisión a S3 con claves de acceso](#setting-up-streaming-to-s3-with-access-keys)". +Then, set up streaming with access keys until the vulnerability is resolved. For more information, see "[Setting up streaming to S3 with access keys](#setting-up-streaming-to-s3-with-access-keys)." {% endif %} -### Configurar la transmisión hacia Azure Blob Storage +### Setting up streaming to Azure Blob Storage -Antes de configurar una transmisión en {% data variables.product.prodname_dotcom %}, primero debes haber creado una cuenta de almacenamiento y un contenedor en Microsoft Azure. Para obtener más información, vea la documentación de Microsoft "[Introducción a Azure Blob Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction)". +Before setting up a stream in {% data variables.product.prodname_dotcom %}, you must first have created a storage account and a container in Microsoft Azure. For details, see the Microsoft documentation, "[Introduction to Azure Blob Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction)." -Para configurar la transmisión en {% data variables.product.prodname_dotcom %}, necesitarás la URL de un token SAS. +To configure the stream in {% data variables.product.prodname_dotcom %} you need the URL of a SAS token. -**En Microsoft Azure Portal**: -1. En la página principal, haga clic en **Cuentas de almacenamiento**. -2. Haga clic en el nombre de la cuenta de almacenamiento que quiere usar y, después, haga clic en **Contenedores**. +**On Microsoft Azure portal**: +1. On the Home page, click **Storage Accounts**. +2. Click the name of the storage account you want to use, then click **Containers**. - ![El enlace de contenedores en Azure](/assets/images/azure/azure-storage-containers.png) + ![The Containers link in Azure](/assets/images/azure/azure-storage-containers.png) -1. Haz clic en el nombre del contenedor que quieres utilizar. -1. Haga clic en **Shared access tokens** (Tokens de acceso compartido). +1. Click the name of the container you want to use. +1. Click **Shared access tokens**. - ![El enlace de token de acceso compartido en Azure](/assets/images/azure/azure-storage-shared-access-tokens.png) + ![The shared access token link in Azure](/assets/images/azure/azure-storage-shared-access-tokens.png) -1. En el menú desplegable **Permisos**, cambie los permisos para permitir únicamente `Create` y `Write`. +1. In the **Permissions** drop-down menu, change the permissions to only allow `Create` and `Write`. - ![El menú desplegable de permisos](/assets/images/azure/azure-storage-permissions.png) + ![The permissions drop-down menu](/assets/images/azure/azure-storage-permissions.png) -1. Configura una fecha de vencimiento que cumpla con tu política de rotación de secretos. -1. Haga clic en **Generar URL y token de SAS**. -1. Copie el valor del campo **URL de SAS de blob** que se muestra. Utilizarás esta URL en {% data variables.product.prodname_dotcom %}. +1. Set an expiry date that complies with your secret rotation policy. +1. Click **Generate SAS token and URL**. +1. Copy the value of the **Blob SAS URL** field that's displayed. You will use this URL in {% data variables.product.prodname_dotcom %}. -**En {% data variables.product.prodname_dotcom %}** : {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. Haga clic en **Configurar secuencia** y seleccione **Azure Blob Storage**. +**On {% data variables.product.prodname_dotcom %}**: +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Click **Configure stream** and select **Azure Blob Storage**. - ![Elige Azure Blob Storage en el menú desplegable](/assets/images/help/enterprises/audit-stream-choice-azureblob.png) + ![Choose Azure Blob Storage from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-azureblob.png) -1. En la página de configuración, ingresa la URL de SAS del blob que copiaste en Azure. El campo **Contenedor** se rellena automáticamente en función de la dirección URL. +1. On the configuration page, enter the blob SAS URL that you copied in Azure. The **Container** field is auto-filled based on the URL. - ![Ingresar la configuración de transmisión](/assets/images/help/enterprises/audit-stream-add-azureblob.png) + ![Enter the stream settings](/assets/images/help/enterprises/audit-stream-add-azureblob.png) -1. Haga clic en **Check endpoint** (Comprobar punto de conexión) para comprobar que {% data variables.product.prodname_dotcom %} puede conectarse y escribir en el punto de conexión de Azure Blob Storage. +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Blob Storage endpoint. - ![Verificar la terminal](/assets/images/help/enterprises/audit-stream-check.png) + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -### Configurar la transmisión hacia Azure Event Hubs +### Setting up streaming to Azure Event Hubs -Antes de configurar una transmisión en {% data variables.product.prodname_dotcom %}, primero debes tener un espacio designador de nombre para concentradores de eventos en Microsoft Azure. Posteriormente, debes crear una instancia de concentrador de eventos dentro del designador de nombre. Necesitarás los detalles de esta instancia de concentrador de eventos cuando configures la transmisión. Para obtener más información, vea la documentación de Microsoft "[Inicio rápido: Creación de un centro de eventos mediante Azure Portal](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create)". +Before setting up a stream in {% data variables.product.prodname_dotcom %}, you must first have an event hub namespace in Microsoft Azure. Next, you must create an event hub instance within the namespace. You'll need the details of this event hub instance when you set up the stream. For details, see the Microsoft documentation, "[Quickstart: Create an event hub using Azure portal](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create)." -Necesitas dos partes de información sobre tu concentrador de eventos: su nombre de instancia y la secuencia de conexión. +You need two pieces of information about your event hub: its instance name and the connection string. -**En Microsoft Azure Portal**: -1. Busque "Event Hubs". +**On Microsoft Azure portal**: +1. Search for "Event Hubs". - ![La caja de búsqueda del portal de Azure](/assets/images/azure/azure-resources-search.png ) + ![The Azure portal search box](/assets/images/azure/azure-resources-search.png ) -1. Seleccione **Centro de eventos**. Se listarán los nombres de tus concentradores de eventos. +1. Select **Event Hubs**. The names of your event hubs are listed. - ![Una lista de concentradores de eventos](/assets/images/help/enterprises/azure-event-hubs-list.png) + ![A list of event hubs](/assets/images/help/enterprises/azure-event-hubs-list.png) -1. Haz una nota del nombre del concentrador de eventos al cual quieras transmitir. -1. Haz clic en el concentrador de eventos requerido. En el menú de la izquierda, seleccione **Directivas de acceso compartido**. -1. Selecciona las políticas de acceso compartido de la lista de políticas o crea una nueva. +1. Make a note of the name of the event hub you want to stream to. +1. Click the required event hub. Then, in the left menu, select **Shared Access Policies**. +1. Select a shared access policy in the list of policies, or create a new policy. - ![Una lista de políticas de acceso compartidas](/assets/images/help/enterprises/azure-shared-access-policies.png) + ![A list of shared access policies](/assets/images/help/enterprises/azure-shared-access-policies.png) -1. Haga clic en el botón situado a la derecha del campo **Connection string-primary key** (Clave principal de cadena de conexión) para copiar la cadena de conexión. +1. Click the button to the right of the **Connection string-primary key** field to copy the connection string. - ![La secuencia de conexión del concentrador de eventos](/assets/images/help/enterprises/azure-connection-string.png) + ![The event hub connection string](/assets/images/help/enterprises/azure-connection-string.png) -**En {% data variables.product.prodname_dotcom %}** : {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. Haga clic en **Configurar secuencia** y seleccione **Azure Event Hubs**. +**On {% data variables.product.prodname_dotcom %}**: +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Click **Configure stream** and select **Azure Event Hubs**. - ![Elige Azure Events hub del menú desplegable](/assets/images/help/enterprises/audit-stream-choice-azure.png) + ![Choose Azure Events Hub from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-azure.png) -1. En la página de configuración, ingresa: - * El nombre de la instancia de Azure Event Hubs. - * La cadena de conexión. +1. On the configuration page, enter: + * The name of the Azure Event Hubs instance. + * The connection string. - ![Ingresar la configuración de transmisión](/assets/images/help/enterprises/audit-stream-add-azure.png) + ![Enter the stream settings](/assets/images/help/enterprises/audit-stream-add-azure.png) -1. Haga clic en **Check endpoint** (Comprobar punto de conexión) para comprobar que {% data variables.product.prodname_dotcom %} puede conectarse y escribir en el punto de conexión de Azure Event Hubs. +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Events Hub endpoint. - ![Verificar la terminal](/assets/images/help/enterprises/audit-stream-check.png) + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} {% ifversion streaming-datadog %} -### Configuración de la transmisión a Datadog +### Setting up streaming to Datadog -Para configurar la transmisión a Datadog, debes crear un token de cliente o una clave de API en Datadog y, a continuación, configurar la transmisión de registros de auditoría en {% data variables.product.product_name %} mediante el token para la autenticación. No es necesario crear un cubo u otro contenedor de almacenamiento en Datadog. +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. -Después de configurar el streaming en Datadog, puedes ver los datos del registro de auditoría filtrando por "github.audit.streaming". Para más información, consulta [Administración de registros](https://docs.datadoghq.com/logs/). +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). -1. Si aún no tienes una cuenta de Datadog, crea una. -1. En Datadog, genera un token de cliente o una clave de API y, a continuación, haz clic en **Copiar clave**. Para obtener más información, consulta [API y claves de aplicación](https://docs.datadoghq.com/account_management/api-app-keys/) en Datadog Docs. {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. Selecciona la lista desplegable **Configurar secuencia** y haz clic en **Datadog**. +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. - ![Captura de pantalla del menú desplegable "Configurar secuencia" con "Datadog" resaltado](/assets/images/help/enterprises/audit-stream-choice-datadog.png) -1. En "Token", pega el token que copiaste anteriormente. + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. - ![Captura de pantalla del campo "Token"](/assets/images/help/enterprises/audit-stream-datadog-token.png) -1. Selecciona el menú desplegable "Sitio" y haz clic en el sitio de Datadog. Para determinar el sitio de Datadog, compara la dirección URL de Datadog con la tabla de [sitios de Datadog](https://docs.datadoghq.com/getting_started/site/) en Datadog Docs. + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. - ![Captura de pantalla del menú desplegable "Desde"](/assets/images/help/enterprises/audit-stream-datadog-site.png) -1. Para comprobar que {% data variables.product.prodname_dotcom %} se puede conectar al punto de conexión de Datadog y puedes escribir en él, haz clic en **Comprobar punto de conexión**. + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. - ![Comprobar el punto de conexión](/assets/images/help/enterprises/audit-stream-check.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -1. Después de unos minutos, confirma que los datos del registro de auditoría aparecen en la pestaña **Registros** de Datadog. Si los datos del registro de auditoría no aparecen, confirma que el token y el sitio son correctos en {% data variables.product.prodname_dotcom %}. + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. {% endif %} -### Configurar la transmisión para Google Cloud Storage +### Setting up streaming to Google Cloud Storage -Para configurar la transmisión al Almacenamiento de Google Cloud, debes crear una cuenta de servicio en Google Cloud con las credenciales y permisos adecuados y luego configurar la transmisión de bitácoras de auditoría en {% data variables.product.product_name %} utilizando las credenciales de la cuenta de servicio para la autenticación. +To set up streaming to Google Cloud Storage, you must create a service account in Google Cloud with the appropriate credentials and permissions, then configure audit log streaming in {% data variables.product.product_name %} using the service account's credentials for authentication. -1. Crea una cuenta de servicio de Google Cloud. No necesitas configurar controles de acceso o roles de IAM para la cuenta de servicio. Para obtener más información, vea [Crear y administrar cuentas de servicio](https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating) en la documentación de Google Cloud. -1. Crear una llave de JSON para la cuenta de servicio y almacenarla de forma segura. Para obtener más información, vea [Crear y administrar claves de cuentas de servicio](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating) en la documentación de Google Cloud. -1. Si aún no has creado un bucket, házlo ahora. Para obtener más información, vea [Crear cubos de almacenamiento](https://cloud.google.com/storage/docs/creating-buckets) en la documentación de Google Cloud. -1. Dale a la cuenta de servicio el el rol de Credor de Objetos de Almacenamiento para el bucket. Para obtener más información, vea [Usar permisos de Cloud IAM](https://cloud.google.com/storage/docs/access-control/using-iam-permissions#bucket-add) en la documentación de Google Cloud. +1. Create a service account for Google Cloud. You do not need to set access controls or IAM roles for the service account. For more information, see [Creating and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating) in the Google Cloud documentation. +1. Create a JSON key for the service account, and store the key securely. For more information, see [Creating and managing service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating) in the Google Cloud documentation. +1. If you haven't created a bucket yet, create the bucket. For more information, see [Creating storage buckets](https://cloud.google.com/storage/docs/creating-buckets) in the Google Cloud documentation. +1. Give the service account the Storage Object Creator role for the bucket. For more information, see [Using Cloud IAM permissions](https://cloud.google.com/storage/docs/access-control/using-iam-permissions#bucket-add) in the Google Cloud documentation. {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. Seleccione el menú desplegable Configurar secuencia y haga clic en **Google Cloud Storage**. +1. Select the Configure stream drop-down menu and click **Google Cloud Storage**. - ![Captura de pantalla del menú desplegable "Configurar secuencia"](/assets/images/help/enterprises/audit-stream-choice-google-cloud-storage.png) + ![Screenshot of the "Configure stream" drop-down menu](/assets/images/help/enterprises/audit-stream-choice-google-cloud-storage.png) -1. Debajo de "Bucket", teclea el nombre de tu bucket de Google Cloud Storage. +1. Under "Bucket", type the name of your Google Cloud Storage bucket. - ![Captura de pantalla del campo de texto "Cubo"](/assets/images/help/enterprises/audit-stream-bucket-google-cloud-storage.png) + ![Screenshot of the "Bucket" text field](/assets/images/help/enterprises/audit-stream-bucket-google-cloud-storage.png) -1. Debajo de "Credenciales de JSON", pega todo el contenido del archivo para tu llave JSON de la cuenta de servicio. +1. Under "JSON Credentials", paste the entire contents of the file for your service account's JSON key. - ![Captura de pantalla del campo de texto "Credenciales JSON"](/assets/images/help/enterprises/audit-stream-json-credentials-google-cloud-storage.png) + ![Screenshot of the "JSON Credentials" text field](/assets/images/help/enterprises/audit-stream-json-credentials-google-cloud-storage.png) -1. Para comprobar que {% data variables.product.prodname_dotcom %} puede conectarse y escribir en el cubo de Google Cloud Storage, haga clic en **Check endpoint** (Comprobar punto de conexión). +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Google Cloud Storage bucket, click **Check endpoint**. - ![Captura de pantalla del botón "Comprobar punto de conexión"](/assets/images/help/enterprises/audit-stream-check-endpoint-google-cloud-storage.png) + ![Screenshot of the "Check endpoint" button](/assets/images/help/enterprises/audit-stream-check-endpoint-google-cloud-storage.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -### Configurar la transmisión a Splunk +### Setting up streaming to Splunk -Para transmitir bitácoras de auditoría a la terminal del Recolector de Eventos HTTP (HEC) de Splunk, debes asegurarte de que la terminal se configure para aceptar conexiones HTTPS. Para obtener más información, vea [Configuración y uso del recopilador de eventos HTTP en Splunk Web](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) en la documentación de Splunk. +To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must make sure that the endpoint is configured to accept HTTPS connections. For more information, see [Set up and use HTTP Event Collector in Splunk Web](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) in the Splunk documentation. {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. Haga clic en **Configurar secuencia** y seleccione **Splunk**. +1. Click **Configure stream** and select **Splunk**. - ![Elige Splunk desde el menú desplegable](/assets/images/help/enterprises/audit-stream-choice-splunk.png) + ![Choose Splunk from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-splunk.png) -1. En la página de configuración, ingresa: - * El dominio en el cual se hospeda la aplicación que quieres transmitir. +1. On the configuration page, enter: + * The domain on which the application you want to stream to is hosted. - Si usa Splunk Cloud, `Domain` debe ser `http-inputs-`, donde `host` es el dominio que usa en Splunk Cloud. Por ejemplo: `http-inputs-mycompany.splunkcloud.com`. + If you are using Splunk Cloud, `Domain` should be `http-inputs-`, where `host` is the domain you use in Splunk Cloud. For example: `http-inputs-mycompany.splunkcloud.com`. - * El puerto mediante el cual la aplicación acepta datos.
+ * The port on which the application accepts data.
- Si usa Splunk Cloud, `Port` debe ser `443` si no ha cambiado la configuración del puerto. Si usa la versión de evaluación gratuita de Splunk Cloud, `Port` debe ser `8088`. + If you are using Splunk Cloud, `Port` should be `443` if you haven't changed the port configuration. If you are using the free trial version of Splunk Cloud, `Port` should be `8088`. - * Un token que pueda utilizar {% data variables.product.prodname_dotcom %} para autenticarse a la aplicación de terceros. + * A token that {% data variables.product.prodname_dotcom %} can use to authenticate to the third-party application. - ![Ingresar la configuración de transmisión](/assets/images/help/enterprises/audit-stream-add-splunk.png) + ![Enter the stream settings](/assets/images/help/enterprises/audit-stream-add-splunk.png) -1. Deje activada la casilla **Enable SSL verification** (Habilitar comprobación SSL). +1. Leave the **Enable SSL verification** check box selected. - Las bitácoras de auditoría siempre se transmiten como datos cifrados, sin embargo, si seleccionas esta opción, {% data variables.product.prodname_dotcom %} verificará el certificado SSL de tu instancia de Splunk cuando entregue eventos. La verificación por SSL te ayuda a garantizar que los eventos se entreguen a tu terminal URL con seguridad. Puedes limpiar la selección de esta opción, pero te recomendamos que dejes habilitada la verificación por SSL. -1. Haga clic en **Check endpoint** (Comprobar punto de conexión) para comprobar que {% data variables.product.prodname_dotcom %} puede conectarse y escribir en el punto de conexión de Splunk. - ![Comprobar el punto de conexión](/assets/images/help/enterprises/audit-stream-check-splunk.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} + Audit logs are always streamed as encrypted data, however, with this option selected, {% data variables.product.prodname_dotcom %} verifies the SSL certificate of your Splunk instance when delivering events. SSL verification helps ensure that events are delivered to your URL endpoint securely. You can clear the selection of this option, but we recommend you leave SSL verification enabled. +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Splunk endpoint. + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check-splunk.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} {% ifversion pause-audit-log-stream %} -## Pausar la transmisión de bitácoras de auditoría +## Pausing audit log streaming -El pausar la transmisión te permite realizar el mantenimiento de la aplicación receptora sin perder datos de auditoría. Las bitácoras de auditoría se almacenan por hasta siete días en {% data variables.product.product_location %} y luego se exportan cuando dejas de pausar la transmisión. +Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream. -{% ifversion streaming-datadog %} Datadog solo acepta registros de hasta 18 horas en el pasado. Si pausas una secuencia en un punto de conexión de Datadog durante más de 18 horas, corres el riesgo de perder los registros que Datadog no aceptará después de reanudar la transmisión. +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. {% endif %} {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. Haga clic en **Pause stream** (Pausar secuencia). +1. Click **Pause stream**. - ![Pausar la transmisión](/assets/images/help/enterprises/audit-stream-pause.png) + ![Pause the stream](/assets/images/help/enterprises/audit-stream-pause.png) -1. Se muestra un mensaje de confirmación. Haga clic en **Pause stream** (Pausar secuencia) para confirmar. +1. A confirmation message is displayed. Click **Pause stream** to confirm. -Cuando la aplicación esté lista para recibir registros de auditoría de nuevo, haga clic en **Resume stream** (Reanudar secuencia) para reiniciar los registros de auditoría de streaming. +When the application is ready to receive audit logs again, click **Resume stream** to restart streaming audit logs. {% endif %} -## Borrar la transmisión de bitácoras de auditoría +## Deleting the audit log stream {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. Haga clic en **Delete stream** (Eliminar secuencia). +1. Click **Delete stream**. - ![Borrar la transmisión](/assets/images/help/enterprises/audit-stream-delete.png) + ![Delete the stream](/assets/images/help/enterprises/audit-stream-delete.png) -1. Se muestra un mensaje de confirmación. Haga clic en **Delete stream** (Eliminar secuencia) para confirmar. +1. A confirmation message is displayed. Click **Delete stream** to confirm. diff --git a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index fe9cb82ebb..eb7ca4cae4 100644 --- a/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ For more information about the audit log REST API, see "[Enterprise administrati The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination): ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ You can specify multiple search phrases, such as `created` and `actor`, by separ The query below searches for audit log events for pull requests, where the event occurred on or after Jan 1st, 2022 in the `avocado-corp` enterprise, and the action was performed by the `octocat` user: ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index a4569d589d..eabcedfe38 100644 --- a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -74,13 +74,13 @@ Before you can use the {% data variables.product.prodname_cli %} to add an SSH k To add an SSH authentication key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. ```shell -gh ssh-key add key-file +gh ssh-key add KEY-FILE ``` To include a title for the new key, use the `-t` or `--title` flag. ```shell -gh ssh-key add key-file --title "personal laptop" +gh ssh-key add KEY-FILE --title "personal laptop" ``` If you generated your SSH key by following the instructions in "[Generating a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)", you can add the key to your account with this command. diff --git a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 9d0033a39f..92fa29e8a5 100644 --- a/translations/es-ES/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/translations/es-ES/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -44,17 +44,19 @@ If you are a site administrator for {% data variables.product.product_location % {%- ifversion ghae %} ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + ``` {%- else %} ```shell - $ ssh-keygen -t ed25519 -C "your_email@example.com" + $ ssh-keygen -t ed25519 -C "your_email@example.com" ``` {% note %} **Note:** If you are using a legacy system that doesn't support the Ed25519 algorithm, use: ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" ``` {% endnote %} @@ -62,14 +64,14 @@ If you are a site administrator for {% data variables.product.product_location % This creates a new SSH key, using the provided email as a label. ```shell - > Generating public/private algorithm key pair. + > Generating public/private ALGORITHM key pair. ``` 3. When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location. {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_algorithm): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_ALGORITHM: [Press enter] ``` {% endmac %} @@ -77,7 +79,7 @@ If you are a site administrator for {% data variables.product.product_location % {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_algorithm):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_ALGORITHM):[Press enter] ``` {% endwindows %} @@ -85,15 +87,15 @@ If you are a site administrator for {% data variables.product.product_location % {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/algorithm): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/ALGORITHM):[Press enter] ``` {% endlinux %} 4. At the prompt, type a secure passphrase. For more information, see ["Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)." ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` ## Adding your SSH key to the ssh-agent @@ -110,7 +112,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav ```shell $ open ~/.ssh/config - > The file /Users/you/.ssh/config does not exist. + > The file /Users/YOU/.ssh/config does not exist. ``` * If the file doesn't exist, create the file. @@ -198,7 +200,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% data reusables.command_line.open_the_multi_os_terminal %} 3. Paste the text below, substituting in the email address for your account on {% data variables.product.product_name %}. ```shell - $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "your_email@example.com" + $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "YOUR_EMAIL" ``` {%- ifversion not ghae %} @@ -217,7 +219,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] ``` {% endmac %} @@ -225,7 +227,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endwindows %} @@ -233,14 +235,14 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endlinux %} 6. When you are prompted to type a passphrase, press **Enter**. ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` 7. Add the SSH key to your account on {% data variables.product.prodname_dotcom %}. For more information, see "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md index cf7d059042..e9b3200e36 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -36,7 +36,7 @@ If you have multiple keys or are attempting to sign commits or tags with a key t 1. When committing changes in your local branch, add the -S flag to the git commit command: ```shell - $ git commit -S -m "your commit message" + $ git commit -S -m "YOUR_COMMIT_MESSAGE" # Creates a signed commit ``` 2. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/articles/generating-a-new-gpg-key). diff --git a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md index fac18fab40..e5371adbc6 100644 --- a/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/translations/es-ES/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -19,12 +19,12 @@ topics: 1. To sign a tag, add `-s` to your `git tag` command. ```shell - $ git tag -s mytag + $ git tag -s MYTAG # Creates a signed tag ``` 2. Verify your signed tag by running `git tag -v [tag-name]`. ```shell - $ git tag -v mytag + $ git tag -v MYTAG # Verifies the signed tag ``` diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index 12f3561e01..91f2e8d064 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -1,7 +1,7 @@ --- -title: Configuración de notificaciones para alertas de Dependabot +title: Configuring notifications for Dependabot alerts shortTitle: Configure notifications -intro: 'Optimiza la forma en la que recibes notificaciones de {% data variables.product.prodname_dependabot_alerts %}.' +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies @@ -19,50 +19,51 @@ topics: - Vulnerabilities - Dependencies - Repositories -ms.openlocfilehash: b8810c27a10302a7873fc61a32189f33855140bb -ms.sourcegitcommit: ac00e2afa6160341c5b258d73539869720b395a4 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/09/2022 -ms.locfileid: '147878563' --- -## Acerca de las notificaciones de {% data variables.product.prodname_dependabot_alerts %} -Cuando {% data variables.product.prodname_dependabot %} detecta las dependencias vulnerables{% ifversion GH-advisory-db-supports-malware %} o el malware{% endif %} en tus repositorios, generamos una alerta del {% data variables.product.prodname_dependabot %} y la mostramos en la pestaña Seguridad del repositorio. {% data variables.product.product_name %} notifica a los mantenedores de los repositorios afectados sobre la alerta nueva de acuerdo con sus preferencias de notificaciones.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} está habilitado de forma predeterminada en todos los repositorios públicos. En el caso de las {% data variables.product.prodname_dependabot_alerts %}, predeterminadamente, recibirás {% data variables.product.prodname_dependabot_alerts %} por correo electrónico, agrupadas por la vulnerabilidad específica. +## About notifications for {% data variables.product.prodname_dependabot_alerts %} + +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. {% endif %} -{% ifversion fpt or ghec %} Si eres propietario de la organización, puedes habilitar o deshabilitar {% data variables.product.prodname_dependabot_alerts %} para todos los repositorios de la organización con un solo clic. También puedes establecer si {% data variables.product.prodname_dependabot_alerts %} se habilitarán o deshabilitarán para los repositorios recién creados. Para más información, vea "[Administración de la configuración de seguridad y análisis para la organización](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)". +{% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether {% data variables.product.prodname_dependabot_alerts %} will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} -{% ifversion ghes or ghae %} De forma predeterminada, si el propietario de tu empresa configuró las notificaciones por correo electrónico en ella, recibirás {% data variables.product.prodname_dependabot_alerts %} por este medio. +{% ifversion ghes or ghae %} +By default, if your enterprise owner has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. -Los propietarios de empresas también pueden habilitar las {% data variables.product.prodname_dependabot_alerts %} sin notificaciones. Para obtener más información, consulte "[Habilitación de {% data variables.product.prodname_dependabot %} para la empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". +Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." {% endif %} -## Configurar las notificaciones para las {% data variables.product.prodname_dependabot_alerts %} +## Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} -{% ifversion fpt or ghes or ghec %} Cuando se detecta una alerta nueva de {% data variables.product.prodname_dependabot %}, {% data variables.product.product_name %} notifica a todos los usuarios del repositorio con acceso a las {% data variables.product.prodname_dependabot_alerts %} de acuerdo con sus preferencias de notificación. Recibirás las alertas si estás observando el repositorio, si habilitas las notificaciones para las alertas de seguridad para toda la actividad del repositorio y si es que no lo estás ignorando. Para más información, vea "[Configuración de notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)". +{% ifversion fpt or ghes or ghec %} +When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endif %} -Puedes configurar los ajustes de notificaciones para ti mismo o para tu organización desde el menú desplegable de administrar notificaciones {% octicon "bell" aria-label="The notifications bell" %} que se muestra en la parte superior de cada página. Para más información, vea "[Configuración de notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)". +You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} +{% data reusables.notifications.vulnerable-dependency-notification-options %} + +{% ifversion update-notification-settings-22 %} +![Screenshot of {% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/dependabot/dependabot-notification-frequency.png){% else %} +![Screenshot of the {% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png){% endif %} - ![Opciones de las {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% note %} -**Nota**: Puedes filtrar tus notificaciones en {% data variables.product.company_short %} para mostrar {% data variables.product.prodname_dependabot_alerts %}. Para más información, vea "[Administración de notificaciones de la Bandeja de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)". +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% data reusables.repositories.security-alerts-x-github-severity %} Para obtener más información, consulta "[Configuración de notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)". +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." -## Cómo reducir el ruido de las notificaciones de {% data variables.product.prodname_dependabot_alerts %} +## How to reduce the noise from notifications for {% data variables.product.prodname_dependabot_alerts %} -Si te preocupa recibir demasiadas notificaciones para las {% data variables.product.prodname_dependabot_alerts %}, te recomendamos que te unas al resumen semanal por correo electrónico o que apagues las notificaciones mientras mantienes habilitadas las {% data variables.product.prodname_dependabot_alerts %}. Todavía puedes navegar para ver los {% data variables.product.prodname_dependabot_alerts %} en la pestaña Seguridad del repositorio. Para obtener más información, consulta "[Visualización y actualización de {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)". +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." -## Información adicional +## Further reading -- "[Configuración de notificaciones](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" -- "[Administración de notificaciones desde la bandeja de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" +- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" +- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" diff --git a/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 9dcf891257..5bd218b446 100644 --- a/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/es-ES/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -33,6 +33,12 @@ You must store this file in the `.github` directory of your repository. When you Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)." +{% note %} + +**Note:** You cannot configure {% data variables.product.prodname_dependabot_alerts %} using the *dependabot.yml* file. + +{% endnote %} + The *dependabot.yml* file has two mandatory top-level keys: `version`, and `updates`. You can, optionally, include a top-level `registries` key{% ifversion ghes = 3.5 %} and/or a `enable-beta-ecosystems` key{% endif %}. The file must start with `version: 2`. ## Configuration options for the *dependabot.yml* file diff --git a/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md b/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md index 8eb4e002f8..17af4bb2aa 100644 --- a/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md +++ b/translations/es-ES/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md @@ -42,9 +42,9 @@ While {% data variables.product.prodname_github_codespaces %} provides the benef While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. -## Option 4: Use Remote-Containers and Docker for a local containerized environment +## Option 4: Use the Dev Containers extension and Docker for a local containerized environment -If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. +If your repository has a `devcontainer.json`, consider using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. For more information, see "[Developing inside a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% note %} diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md b/translations/es-ES/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md index fe1dcee67c..2465cfe69e 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md @@ -79,4 +79,4 @@ For more information on deleting a codespace, see "[Deleting a codespace](/codes {% data variables.product.prodname_github_codespaces %} is a cloud-based development environment and requires an internet connection. If you lose connection to the internet while working in a codespace, you will not be able to access your codespace. However, any uncommitted changes will be saved. When you have access to an internet connection again, you can connect to your codespace in the exact same state that it was left in. If you have an unstable internet connection, you should commit and push your changes often. -If you know that you will often be working offline, you can use your `devcontainer.json` file with the ["{% data variables.product.prodname_vscode %} Remote - Containers" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to build and attach to a local development container for your repository. For more information, see [Developing inside a container](https://code.visualstudio.com/docs/remote/containers) in the {% data variables.product.prodname_vscode %} documentation. +If you know that you will often be working offline, you can use your `devcontainer.json` file with the ["Dev Containers" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for {% data variables.product.prodname_vscode_shortname %} to build and attach to a local development container for your repository. For more information, see [Developing inside a container](https://code.visualstudio.com/docs/remote/containers) in the {% data variables.product.prodname_vscode %} documentation. diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md index fe6e0c705e..559ed6dc38 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -73,6 +73,8 @@ Organization owners can specify who can create and use codespaces at the organiz ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + If codespaces for this repository are billable, a message is displayed below the **Create codespace on BRANCH** button telling you who will pay for the codespace. + 1. Create your codespace, either using the default options, or after configuring advanced options: * **Use the default options** @@ -131,12 +133,12 @@ To create a new codespace, use the `gh codespace create` subcommand. gh codespace create ``` -You are prompted to choose a repository, a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available). +You are prompted to choose a repository. If codespaces for this repository are billable, a message is displayed telling you who will pay for the codespace. You are then prompted to choose a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available). Alternatively, you can use flags to specify some or all of the options: ```shell -gh codespace create -r owner/repo -b branch --devcontainer-path path -m machine-type +gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE ``` In this example, replace `owner/repo` with the repository identifier. Replace `branch` with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the `-r` flag without the `b` flag, the codespace is created from the default branch. diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md index eee506d1f6..c5cea6210c 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md @@ -78,7 +78,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por To forward a port use the `gh codespace ports forward` subcommand. Replace `codespace-port:local-port` with the remote and local ports that you want to connect. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports forward codespace-port:local-port +gh codespace ports forward CODESPACE-PORT:LOCAL-PORT ``` For more information about this command, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_codespace_ports_forward). @@ -132,7 +132,7 @@ To change the visibility of a forwarded port, use the `gh codespace ports visibi Replace `codespace-port` with the forwarded port number. Replace `setting` with `private`, `org`, or `public`. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports visibility codespace-port:setting +gh codespace ports visibility CODESPACE-PORT:SETTINGS ``` You can set the visibility for multiple ports with one command. For example: diff --git a/translations/es-ES/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md b/translations/es-ES/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md index 0a582c1557..14283811fc 100644 --- a/translations/es-ES/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md +++ b/translations/es-ES/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md @@ -62,7 +62,7 @@ For a complete reference of `gh` commands for {% data variables.product.prodname {% note %} -**Note**: The `-c codespace-name` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. +**Note**: The `-c CODESPACE_NAME` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. {% endnote %} @@ -77,7 +77,7 @@ The list includes the unique name of each codespace, which you can use in other ### Create a new codespace ```shell -gh codespace create -r owner/repository [-b branch] +gh codespace create -r OWNER/REPO_NAME [-b BRANCH] ``` For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." @@ -85,7 +85,7 @@ For more information, see "[Creating a codespace](/codespaces/developing-in-code ### Stop a codespace ```shell -gh codespace stop -c codespace-name +gh codespace stop -c CODESPACE-NAME ``` For more information, see "[Deep dive into {% data variables.product.prodname_github_codespaces %}](/codespaces/getting-started/deep-dive#closing-or-stopping-your-codespace)." @@ -93,7 +93,7 @@ For more information, see "[Deep dive into {% data variables.product.prodname_gi ### Delete a codespace ```shell -gh codespace delete -c codespace-name +gh codespace delete -c CODESPACE-NAME ``` For more information, see "[Deleting a codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)." @@ -103,7 +103,7 @@ For more information, see "[Deleting a codespace](/codespaces/developing-in-code To run commands on the remote codespace machine, from your terminal, you can SSH into the codespace. ```shell -gh codespace ssh -c codespace-name +gh codespace ssh -c CODESPACE-NAME ``` {% data variables.product.prodname_github_codespaces %} copies your GitHub SSH keys into the codespace on creation for a seamless authentication experience. You may be asked to enter the passphrase for your SSH key, after which you will get a command prompt from the remote codespace machine. @@ -113,7 +113,7 @@ If you don't have any SSH keys, follow the instructions in "[Generating a new SS ### Open a codespace in {% data variables.product.prodname_vscode %} ```shell -gh codespace code -c codespace-name +gh codespace code -c CODESPACE-NAME ``` For more information, see "[Using {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code)." @@ -121,13 +121,13 @@ For more information, see "[Using {% data variables.product.prodname_github_code ### Open a codespace in JupyterLab ```shell -gh codespace jupyter -c codespace-name +gh codespace jupyter -c CODESPACE-NAME ``` ### Copy a file to/from a codespace ```shell -gh codespace cp [-r] source(s) destination +gh codespace cp [-r] SOURCE(S) DESTINATION ``` Use the prefix `remote:` on a file or directory name to indicate that it's on the codespace. As with the UNIX `cp` command, the first argument specifies the source and the last specifies the destination. If the destination is a directory, you can specify multiple sources. Use the `-r` (recursive) flag if any of the sources is a directory. @@ -171,7 +171,7 @@ For more information about the `gh codespace cp` command, including additional f You can forward a port on a codespace to a local port. The port remains forwarded as long as the process is running. To stop forwarding the port, press Control+C. ```shell -gh codespace ports forward codespace-port-number:local-port-number -c codespace-name +gh codespace ports forward CODESPACE-PORT_NAME:LOCAL-PORT-NAME -c CODESPACE-NAME ``` To see details of forwarded ports enter `gh codespace ports` and then choose a codespace. @@ -179,13 +179,13 @@ To see details of forwarded ports enter `gh codespace ports` and then choose a c You can set the visibility of a forwarded port. {% data reusables.codespaces.port-visibility-settings %} ```shell -gh codespace ports visibility codespace-port:private|org|public -c codespace-name +gh codespace ports visibility CODESPACE-PORT:private|org|public -c CODESPACE-NAME ``` You can set the visibility for multiple ports with one command. For example: ```shell -gh codespace ports visibility 80:private 3000:public 3306:org -c codespace-name +gh codespace ports visibility 80:private 3000:public 3306:org -c CODESPACE-NAME ``` For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." @@ -195,7 +195,7 @@ For more information, see "[Forwarding ports in your codespace](/codespaces/deve You can see the creation log for a codespace. After entering this command you will be asked to enter the passphrase for your SSH key. ```shell -gh codespace logs -c codespace-name +gh codespace logs -c CODESPACE-NAME ``` For more information about the creation log, see "[{% data variables.product.prodname_github_codespaces %} logs](/codespaces/troubleshooting/github-codespaces-logs#creation-logs)." diff --git a/translations/es-ES/content/codespaces/overview.md b/translations/es-ES/content/codespaces/overview.md index 447eb37a35..4c07f6674a 100644 --- a/translations/es-ES/content/codespaces/overview.md +++ b/translations/es-ES/content/codespaces/overview.md @@ -41,3 +41,5 @@ You can also personalize aspects of your codespace environment by using a public For information on pricing, storage, and usage for {% data variables.product.prodname_github_codespaces %}, see "[About billing for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)." {% data reusables.codespaces.codespaces-spending-limit-requirement %} For information on how organizations owners and billing managers can manage the spending limit for {% data variables.product.prodname_github_codespaces %} for an organization, see "[Managing spending limits for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-github-codespaces)." + +You can see who will pay for a codespace before you create it. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)." \ No newline at end of file diff --git a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 4ab4dec53c..9c44b43045 100644 --- a/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/translations/es-ES/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -27,9 +27,7 @@ Before you can configure prebuilds for your project the following must be true: ## Configuring a prebuild -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% octicon "codespaces" aria-label="The Codespaces icon" %} {% data variables.product.prodname_codespaces %}**. +{% data reusables.codespaces.accessing-prebuild-configuration %} 1. In the "Prebuild configuration" section of the page, click **Set up prebuild**. ![The 'Set up prebuilds' button](/assets/images/help/codespaces/prebuilds-set-up.png) @@ -80,6 +78,12 @@ Before you can configure prebuilds for your project the following must be true: ![The prebuild failure notification setting](/assets/images/help/codespaces/prebuilds-failure-notification-setting.png) +1. Optionally, at the bottom of the page, click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) + + In the "Advanced options" section, if you select **Disable prebuild optimization**, codespaces will be created without a prebuild if the latest prebuild workflow has failed or is currently running. For more information, see "[Troubleshooting prebuilds](/codespaces/troubleshooting/troubleshooting-prebuilds#preventing-out-of-date-prebuilds-being-used)." + 1. Click **Create**. {% data reusables.codespaces.prebuilds-permission-authorization %} diff --git a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index bd189eecbe..03f5eefc01 100644 --- a/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/es-ES/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -126,7 +126,7 @@ You can choose from a list of predefined configurations to create a dev containe Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project. For more information about the definitions of predefined dev containers, see the [`devcontainers/images`](https://github.com/devcontainers/images/tree/main/src) repository. -You can add a predefined dev container configuration either while working in a codespace, or while working on a repository locally. To do this in {% data variables.product.prodname_vscode_shortname %} while you are working locally, and not connected to a codespace, you must have the "Remote - Containers" extension installed and enabled. For more information about this extension, see the [{% data variables.product.prodname_vs_marketplace_shortname %}](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). The following procedure describes the process when you are using a codespace. The steps in {% data variables.product.prodname_vscode_shortname %} when you are not connected to a codespace are very similar. +You can add a predefined dev container configuration either while working in a codespace, or while working on a repository locally. To do this in {% data variables.product.prodname_vscode_shortname %} while you are working locally, and not connected to a codespace, you must have the "Dev Containers" extension installed and enabled. For more information about this extension, see the [{% data variables.product.prodname_vs_marketplace_shortname %}](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). The following procedure describes the process when you are using a codespace. The steps in {% data variables.product.prodname_vscode_shortname %} when you are not connected to a codespace are very similar. {% data reusables.codespaces.command-palette-container %} 1. Click the definition you want to use. diff --git a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index b0d92d091d..e029c962f6 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -30,6 +30,38 @@ If you create a codespace and it does not open: If you still cannot create a codespace for a repository where {% data variables.product.prodname_github_codespaces %} is available, {% data reusables.codespaces.contact-support %} +### Codespace creation fails + +If the creation of a codespace fails, it's likely to be due to a temporary infrastructure issue in the cloud - for example, a problem provisioning a virtual machine for the codespace. A less common reason for failure is if it takes longer than an hour to build the container. In this case, the build is cancelled and codespace creation will fail. + +{% note %} + +**Note:** A codespace that was not successfully created is never going to be usable and should be deleted. For more information, see "[Deleting a codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)." + +{% endnote %} + +If you create a codespace and the creation fails: + +1. Check {% data variables.product.prodname_dotcom %}'s [Status page](https://githubstatus.com) for any active incidents. +1. Go to [your {% data variables.product.prodname_github_codespaces %} page](https://github.com/codespaces), delete the codespace, and create a new codespace. +1. If the container is building, look at the logs that are streaming and make sure the build is not stuck. A container build that takes longer than one hour will be canceled, resulting in a failed creation. + + One common scenario where this could happen is if you have a script running that is prompting for user input and waiting for an answer. If this is the case, remove the interactive prompt so that the build can complete non-interactively. + + {% note %} + + **Note**: To view the logs during a build: + * In the browser, click **View logs.** + + ![Screenshot of the Codespaces web UI with the View logs link emphasized](/assets/images/help/codespaces/web-ui-view-logs.png) + + * In the VS Code desktop application, click **Building codespace** in the "Setting up remote connection" that's displayed. + + ![Screenshot of VS Code with the Building codespace link emphasized](/assets/images/help/codespaces/vs-code-building-codespace.png) + + {% endnote %} +2. If you have a container that takes a long time to build, consider using prebuilds to speed up codespace creations. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." + ## Deleting codespaces The owner of a codespace has full control over it and only they can delete their codespaces. You cannot delete a codespace created by another user. diff --git a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index 7c4b0ca4e8..45f62d023a 100644 --- a/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/translations/es-ES/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -65,6 +65,24 @@ If the `devcontainer.json` configuration file for a prebuild configuration is up If the workflow runs for a prebuild configuration are failing, you can temporarily disable the prebuild configuration while you investigate. For more information, see "[Managing prebuilds](/codespaces/prebuilding-your-codespaces/managing-prebuilds#disabling-a-prebuild-configuration)." +### Preventing out-of-date prebuilds being used + +By default, if the latest prebuild workflow has failed, then a previous prebuild for the same combination of repository, branch, and `devcontainer.json` configuration file will be used to create new codespaces. This behavior is called prebuild optimization. + +We recommend keeping prebuild optimization enabled, because it helps ensure that codespaces can still be created quickly if an up-to-date prebuild is not available. However, as a repository administrator, you can disable prebuild optimization if you run into problems with prebuilt codespaces being behind the current state of the branch. If you disable prebuild optimization, codespaces for the relevant combination of repository, branch, and `devcontainer.json` file will be created without a prebuild if the latest prebuild workflow has failed or is currently running. + +{% data reusables.codespaces.accessing-prebuild-configuration %} +1. To the right of the affected prebuild configuration, select the ellipsis (**...**), then click **Edit**. + + ![Screenshot of a list of prebuilds, with "Edit" highlighted](/assets/images/help/codespaces/edit-prebuild-configuration.png) +1. Scroll to the bottom of the "Edit configuration" page and click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) +1. If you're sure you want to disable the default setting, select **Disable prebuild optimization**. + + ![Screenshot of the advanced option section and the "disable prebuild optmization" setting](/assets/images/help/codespaces/disable-prebuild-optimization.png) +1. To save your change, click **Update**. + ## Further reading - "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds)" diff --git a/translations/es-ES/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/translations/es-ES/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index 5fe3fc3bb3..17139235ce 100644 --- a/translations/es-ES/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/translations/es-ES/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -1,6 +1,6 @@ --- -title: Configurar pautas para los colaboradores de repositorios -intro: Puedes crear pautas para comunicar cómo pueden contribuir las personas a tu proyecto. +title: Setting guidelines for repository contributors +intro: You can create guidelines to communicate how people should contribute to your project. versions: fpt: '*' ghes: '*' @@ -13,59 +13,56 @@ redirect_from: topics: - Community shortTitle: Contributor guidelines -ms.openlocfilehash: b418c5a3d10f8b8f7572f33b17a9ebfbb3de27d3 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147578792' --- -## Acerca de los lineamientos de contribución -Para ayudar a los colaboradores de su proyecto a realizar un buen trabajo, puede agregar un archivo con las pautas de contribución a la raíz del repositorio del proyecto, `docs` o la carpeta `.github`. Cuando alguien abre una solicitud de extracción o crea una propuesta, verán un enlace a ese archivo. El vínculo a las pautas de contribución también aparece en la página `contribute` del repositorio. Para obtener un ejemplo de una página `contribute`, vea [github/docs/contribute](https://github.com/github/docs/contribute). +## About contributing guidelines +To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file. The link to the contributing guidelines also appears on your repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). ![contributing-guidelines](/assets/images/help/pull_requests/contributing-guidelines.png) -Para el propietario del repositorio, las pautas de contribución son una manera de comunicar cómo deben contribuir las personas. +For the repository owner, contribution guidelines are a way to communicate how people should contribute. -Para los colaboradores, las pautas los ayudan a verificar que están presentando solicitudes de extracción conformadas correctamente y abriendo propuestas útiles. +For contributors, the guidelines help them verify that they're submitting well-formed pull requests and opening useful issues. -Tanto para los propietarios como para los colaboradores, las pautas de contribución ahorran tiempo y evitan inconvenientes generados por solicitudes de extracción o propuestas creadas de manera incorrecta que deben ser rechazadas o se deben volver a presentar. +For both owners and contributors, contribution guidelines save time and hassle caused by improperly created pull requests or issues that have to be rejected and re-submitted. {% ifversion fpt or ghes or ghec %} -Puedes crear pautas de contribución predeterminadas para tu organización{% ifversion fpt or ghes or ghec %} o cuenta personal{% endif %}. Para más información, vea "[Creación de un archivo de estado de la comunidad predeterminado](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)". +You can create default contribution guidelines for your organization{% ifversion fpt or ghes or ghec %} or personal account{% endif %}. For more information, see "[Creating a default community health file](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% tip %} -**Sugerencia**: los mantenedores de repositorios pueden establecer pautas específicas para las incidencias creando una plantilla de incidencia o de solicitud de incorporación de cambios para el repositorio. Para más información, vea "[Acerca de las plantillas de incidencias y solicitudes de incorporación de cambios](/articles/about-issue-and-pull-request-templates)". +**Tip:** Repository maintainers can set specific guidelines for issues by creating an issue or pull request template for the repository. For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." {% endtip %} -## Agregar un archivo *CONTRIBUTING* +## Adding a *CONTRIBUTING* file -{% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. Decida si quiere almacenar las pautas de contribución en la raíz del repositorio, en `docs` o en el directorio `.github`. Después, en el campo nombre de archivo, escribe el nombre y la extensión del archivo. Los nombres de archivo de los lineamientos de contribución no distinguen entre mayúsculas y minúsculas. Los archivos se interpretan en formato de texto rico si la extensión de archivo se encuentra en un formato compatible. Para obtener más información, vea "[Trabajar con archivos que no son de código](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)". - ![Nuevo nombre de archivo](/assets/images/help/repository/new-file-name.png) - - Para hacer visibles sus pautas de contribución en el directorio raíz del repositorio, escriba *CONTRIBUTING*. - - Para hacer visible sus pautas de contribución en el directorio `docs` del repositorio, escriba *docs/* para crear el directorio y luego *CONTRIBUTING*. - - Si un repositorio contiene más de un archivo *CONTRIBUTING*, el archivo que se muestra en los vínculos se elige de las ubicaciones en el siguiente orden: el directorio `.github`, luego el directorio raíz del repositorio y finalmente el directorio `docs`. -4. En el nuevo archivo, agrega las pautas de contribución. Pueden incluir: - - Pasos para crear buenas propuestas o solicitudes de extracción. - - Enlaces a la documentación externa, listas de correos o un código de conducta. - - Expectativas de comportamiento y de la comunidad. -{% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.files.add-file %} +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." + ![New file name](/assets/images/help/repository/new-file-name.png) + - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. + - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. + - If a repository contains more than one *CONTRIBUTING* file, then the file shown in links is chosen from locations in the following order: the `.github` directory, then the repository's root directory, and finally the `docs` directory. +4. In the new file, add contribution guidelines. These could include: + - Steps for creating good issues or pull requests. + - Links to external documentation, mailing lists, or a code of conduct. + - Community and behavioral expectations. +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_new_file %} -## Ejemplos de pautas de contribución +## Examples of contribution guidelines -Si estás confundido, aquí hay algunos buenos ejemplos de pautas de contribución: +If you're stumped, here are some good examples of contribution guidelines: -- [Pautas de contribución](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) del editor Atom. -- [Pautas de contribución](https://github.com/rails/rails/blob/main/CONTRIBUTING.md) de Ruby on Rails. -- [Pautas de contribución](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md) de Open Government. +- The {% data variables.product.prodname_docs %} [contribution guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md). +- The Ruby on Rails [contribution guidelines](https://github.com/rails/rails/blob/main/CONTRIBUTING.md). +- The Open Government [contribution guidelines](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md). -## Información adicional -- La sección de Guías de código abierto "[Iniciar un proyecto de código abierto](https://opensource.guide/starting-a-project/)"{% ifversion fpt or ghec %} +## Further reading +- The Open Source Guides' section "[Starting an Open Source Project](https://opensource.guide/starting-a-project/)"{% ifversion fpt or ghec %} - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}{% ifversion fpt or ghes or ghec %} -- "[Agregar una licencia a un repositorio](/articles/adding-a-license-to-a-repository)"{% endif %} +- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)"{% endif %} diff --git a/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md b/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md index 6d7820989b..42d4793a90 100644 --- a/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md +++ b/translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md @@ -1,6 +1,6 @@ --- -title: Realizar cambios en una rama -intro: 'Usa tu editor de texto favorito, como [Atom](https://atom.io/), para realizar cambios en el proyecto y, a continuación, utiliza {% data variables.product.prodname_desktop %} para visualizar confirmaciones útiles.' +title: Making changes in a branch +intro: 'Use your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), to make changes to your project, then use {% data variables.product.prodname_desktop %} to visualize useful commits.' redirect_from: - /desktop/contributing-to-projects/making-changes-in-a-branch versions: @@ -12,11 +12,5 @@ children: - /viewing-the-branch-history - /pushing-changes-to-github shortTitle: Make changes in a branch -ms.openlocfilehash: 3ff1729cdf050f3604c383d965dda117b5a18e42 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/11/2022 -ms.locfileid: '145092312' --- diff --git a/translations/es-ES/content/developers/overview/managing-deploy-keys.md b/translations/es-ES/content/developers/overview/managing-deploy-keys.md index 3e7d7854f6..45e840a023 100644 --- a/translations/es-ES/content/developers/overview/managing-deploy-keys.md +++ b/translations/es-ES/content/developers/overview/managing-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: Administrar las llaves de despliegue -intro: Aprende las diversas formas de administrar llaves SSH en tus servidores cuando automatizas los scripts de desplegue y averigua qué es lo mejor para ti. +title: Managing deploy keys +intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - /guides/managing-deploy-keys - /v3/guides/managing-deploy-keys @@ -14,91 +14,90 @@ versions: ghec: '*' topics: - API -ms.openlocfilehash: 425535eb582c84801d79f00df751bb48d4a5b05e -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146058472' --- -Puedes administrar llaves SSH en tus servidores cuando automatices tus scripts de despliegue utilizando el reenvío del agente de SSH, HTTPS con tokens de OAuth, o usuarios máquina. -## Reenvío del agente SSH -En muchos casos, especialmente al inicio de un proyecto, el reenvío del agente SSH es el método más fácil y rápido a utilizar. El reenvío de agentes utiliza las mismas llaves SSH que utiliza tu ordenador de desarrollo local. +You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users. -#### Ventajas +## SSH agent forwarding -* No tienes que generar o llevar registros de las llaves nuevas. -* No hay administración de llaves; los usuarios tienen los mismos permisos en el servidor y localmente. -* No se almacenan las llaves en el servidor, así que, en caso de que el servidor se ponga en riesgo, no necesitas buscar y eliminar las llaves con este problema. +In many cases, especially in the beginning of a project, SSH agent forwarding is the quickest and simplest method to use. Agent forwarding uses the same SSH keys that your local development computer uses. -#### Desventajas +#### Pros -* Los usuarios **deben** utilizar SSH para la implementación; no se pueden usar procesos de implementación automatizados. -* El reenvío del agente SSH puede ser difícil de ejecutar para usuarios de Windows. +* You do not have to generate or keep track of any new keys. +* There is no key management; users have the same permissions on the server that they do locally. +* No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys. -#### Configurar +#### Cons -1. Habilita el reenvío de agente localmente. Vea [nuestra guía sobre el reenvío de agentes SSH][ssh-agent-forwarding] para más información. -2. Configura tus scripts de despliegue para utilizar el reenvío de agente. Por ejemplo, en un script de Bash, la habilitación del reenvío de agentes tendría un aspecto similar al siguiente: `ssh -A serverA 'bash -s' < deploy.sh` +* Users **must** SSH in to deploy; automated deploy processes can't be used. +* SSH agent forwarding can be troublesome to run for Windows users. -## Clonado de HTTPS con tokens de OAuth +#### Setup -Si no quieres utilizar llaves SSH, puedes utilizar HTTPS con tokens de OAuth. +1. Turn on agent forwarding locally. See [our guide on SSH agent forwarding][ssh-agent-forwarding] for more information. +2. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: +`ssh -A serverA 'bash -s' < deploy.sh` -#### Ventajas +## HTTPS cloning with OAuth tokens -* Cualquiera que tenga acceso al servidor puede desplegar el repositorio. -* Los usuarios no tienen que implementar la configuración local de SSH. -* No se necesitan tokens múltiples (uno por usuario); un token por servidor es suficiente. -* Los tokens se pueden revocar en cualquier momento, convirtiéndolos esencialmente en una contraseña de un solo uso. +If you don't want to use SSH keys, you can use HTTPS with OAuth tokens. + +#### Pros + +* Anyone with access to the server can deploy the repository. +* Users don't have to change their local SSH settings. +* Multiple tokens (one for each user) are not needed; one token per server is enough. +* A token can be revoked at any time, turning it essentially into a one-use password. {% ifversion ghes %} -* La generación de nuevos tokens se puede incluir fácilmente en un script mediante [la API de OAuth](/rest/reference/oauth-authorizations#create-a-new-authorization). +* Generating new tokens can be easily scripted using [the OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization). {% endif %} -#### Desventajas +#### Cons -* Debes asegurarte de que configuras tu token con los alcances de acceso correctos. -* Los tokens son prácticamente contraseñas, y deben protegerse de la misma manera. +* You must make sure that you configure your token with the correct access scopes. +* Tokens are essentially passwords, and must be protected the same way. -#### Configurar +#### Setup -Vea [nuestra guía sobre cómo crear un token de acceso personal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +See [our guide on creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). -## Claves de implementación +## Deploy keys {% data reusables.repositories.deploy-keys %} {% data reusables.repositories.deploy-keys-write-access %} -#### Ventajas +#### Pros -* Cualquiera que tenga acceso al repositorio y al servidor tiene la capacidad de desplegar el proyecto. -* Los usuarios no tienen que implementar la configuración local de SSH. -* Las claves de implementación son de solo lectura de forma predeterminada, pero puede darles acceso de escritura al agregarlas a un repositorio. +* Anyone with access to the repository and server has the ability to deploy the project. +* Users don't have to change their local SSH settings. +* Deploy keys are read-only by default, but you can give them write access when adding them to a repository. -#### Desventajas +#### Cons -* Las llaves de despliegue solo otorgan acceso a un solo repositorio. Los proyectos más complejos pueden tener muchos repositorios que extraer del mismo servidor. -* Las llaves de lanzamiento habitualmente no están protegidas con una frase de acceso, lo cual hace que se pueda acceder fácilmente a ellas si el servidor estuvo en riesgo. +* Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server. +* Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised. -#### Configurar +#### Setup -1. [Ejecuta el procedimiento`ssh-keygen` ][generating-ssh-keys] en el servidor y recuerda dónde guardas el par de claves RSA públicas y privadas generado. -2. En la esquina superior derecha de cualquier página de {% data variables.product.product_name %}, haga clic en la fotografía de perfil y luego en **Your profile**. ![Navegación al perfil](/assets/images/profile-page.png) -3. En la página del perfil, haga clic en **Repositories** y después en el nombre del repositorio. ![Vínculo Repositories](/assets/images/repos.png) -4. Desde el repositorio, haga clic en **Settings**. ![Configuración del repositorio](/assets/images/repo-settings.png) -5. En la barra lateral, haga clic en **Deploy Keys** y después en **Add deploy key**. ![Vínculo para agregar claves de implementación](/assets/images/add-deploy-key.png) -6. Proporciona un título, pégalo en tu llave pública. ![Página de la llave de despliegue](/assets/images/deploy-key.png) -7. Seleccione **Allow write access** si quiere que esta clave tenga acceso de escritura en el repositorio. Una llave de despliegue con acceso de escritura permite que un despliegue cargue información al repositorio. -8. Haga clic en **Add key**. +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server, and remember where you save the generated public and private rsa key pair. +{% data reusables.profile.navigating-to-profile %} -#### Utilizar repositorios múltiples en un servidor + ![Navigation to profile](/assets/images/profile-page.png) +1. On your profile page, click **Repositories**, then click the name of your repository. ![Repositories link](/assets/images/repos.png) +2. From your repository, click **Settings**. ![Repository settings](/assets/images/repo-settings.png) +3. In the sidebar, click **Deploy Keys**, then click **Add deploy key**. ![Add Deploy Keys link](/assets/images/add-deploy-key.png) +4. Provide a title, paste in your public key. ![Deploy Key page](/assets/images/deploy-key.png) +5. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. +6. Click **Add key**. -Si utilizas repositorios múltiples en un servidor, necesitarás generar un par de llaves dedicados para cada uno. No puedes reutilizar una llave de despliegue para repositorios múltiples. +#### Using multiple repositories on one server -En el archivo de configuración SSH del servidor (habitualmente `~/.ssh/config`), agregue una entrada de alias para cada repositorio. Por ejemplo: +If you use multiple repositories on one server, you will need to generate a dedicated key pair for each one. You can't reuse a deploy key for multiple repositories. + +In the server's SSH configuration file (usually `~/.ssh/config`), add an alias entry for each repository. For example: ```bash Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0 @@ -110,79 +109,79 @@ Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif IdentityFile=/home/user/.ssh/repo-1_deploy_key ``` -* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0`: alias del repositorio. -* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}`: configura el nombre de host que se va a usar con el alias. -* `IdentityFile=/home/user/.ssh/repo-0_deploy_key`: asigna una clave privada al alias. +* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - The repository's alias. +* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias. +* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias. -Entonces podrás utilizar el alias del nombre de host para que interactúe con el repositorio utilizando SSH, lo cual utilizará la llave de despliegue única que se asignó a dicho alias. Por ejemplo: +You can then use the hostname's alias to interact with the repository using SSH, which will use the unique deploy key assigned to that alias. For example: ```bash $ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-1:OWNER/repo-1.git ``` -## Tokens de servidor a servidor +## Server-to-server tokens -Si el servidor tiene que acceder a repositorios en una o más organizaciones, puede usar una aplicación de GitHub para definir el acceso necesario y, luego, generar tokens de _ámbito limitado_ y de _servidor a servidor_ desde esa aplicación de GitHub. Se puede ajustar el alcance de los tokens de servidor a servidor para repositorios múltiples y pueden tener permisos específicos. Por ejemplo, puedes generar un token con acceso de solo lectura al contenido de un repositorio. +If your server needs to access repositories across one or more organizations, you can use a GitHub App to define the access you need, and then generate _tightly-scoped_, _server-to-server_ tokens from that GitHub App. The server-to-server tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents. -Ya que las GitHub Apps son un actor de primera clase en {% data variables.product.product_name %}, los tokens de servidor a servidor se desacoplan de cualquier usuario de GitHub, lo cual los hace comparables con los "tokens de servicio". Adicionalmente, los tokens de servidor a servidor. tienen límites de tasa dedicados que se escalan de acuerdo con el tamaño de las organizaciones sobre las cuales actúan. Para más información, vea [Límites de frecuencia para {% data variables.product.prodname_github_apps %}](/developers/apps/rate-limits-for-github-apps). +Since GitHub Apps are a first class actor on {% data variables.product.product_name %}, the server-to-server tokens are decoupled from any GitHub user, which makes them comparable to "service tokens". Additionally, server-to-server tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for {% data variables.product.prodname_github_apps %}](/developers/apps/rate-limits-for-github-apps). -#### Ventajas +#### Pros -- Tokens de alcance muy específico con conjuntos de permisos bien definidos y tiempos de vencimiento (1 hora o menos si se revocan manualmente utilizando la API). -- Límites de tasa dedicados que crecen con tu organización. -- Desacoplados de las identidades de los usuariso de GitHub para que no consuman plazas de la licencia. -- Nunca se les otorga una contraseña, así que no se puede iniciar sesión directamente en ellos. +- Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API). +- Dedicated rate limits that grow with your organization. +- Decoupled from GitHub user identities, so they do not consume any licensed seats. +- Never granted a password, so cannot be directly signed in to. -#### Desventajas +#### Cons -- Se necesita de una configuración adicional para crear la GitHub App. -- Los tokens de servidor a servidor vencen después de 1 hora, entonces necesitan volver a generarse habitualmente cuando se necesite, utilizando código. +- Additional setup is needed to create the GitHub App. +- Server-to-server tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code. -#### Configurar +#### Setup -1. Determina si tu GitHub App debería ser pública o privada. Si tu GitHub App solo actúa en los repositorios dentro de tu organización, probablemente la quieras como privada. -1. Determina los permisos que necesita tu GitHub App, tales como el acceso de solo lectura al contenido del repositorio. -1. Crea tu GitHub App a través de la página de configuración de tu organización. Para más información, vea [Creación de una aplicación de GitHub](/developers/apps/creating-a-github-app). -1. Anote la aplicación de GitHub `id`. -1. Genera y descarga la llave privada de tu GitHub App y almacénala de forma segura. Para más información, vea [Generación de una clave privada](/developers/apps/authenticating-with-github-apps#generating-a-private-key). -1. Instala tu GitHub App en los repositorios sobre los que necesita actuar, opcionalmente, puedes instalarla en todos los repositorios de tu organización. -1. Identifica el valor `installation_id` que representa la conexión entre la aplicación de GitHub y los repositorios de la organización a los que puede acceder. Cada par de aplicación de GitHub y organización tiene como máximo un único valor `installation_id`. Puede identificar este valor `installation_id` mediante la [Obtención de una instalación de la organización para la aplicación autenticada](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). Para esto es necesario autenticase como una aplicación de GitHub mediante un JWT. Para más información, vea [Autenticación como una aplicación de GitHub](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). -1. Genere un token de servidor a servidor mediante el punto de conexión de la API REST correspondiente, [Crear un token de acceso de instalación para una aplicación](/rest/reference/apps#create-an-installation-access-token-for-an-app). Para esto es necesario autenticase como una aplicación de GitHub mediante un JWT. Para más información, vea [Autenticación como una aplicación de GitHub](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app) y [Autenticación como una instalación](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). -1. Esto requiere que un token de servidor a servidor interactúe con tus repositorios, ya sea a través de la API de REST o de GraphQL, o mediante el cliente de Git. +1. Determine if your GitHub App should be public or private. If your GitHub App will only act on repositories within your organization, you likely want it private. +1. Determine the permissions your GitHub App requires, such as read-only access to repository contents. +1. Create your GitHub App via your organization's settings page. For more information, see [Creating a GitHub App](/developers/apps/creating-a-github-app). +1. Note your GitHub App `id`. +1. Generate and download your GitHub App's private key, and store this safely. For more information, see [Generating a private key](/developers/apps/authenticating-with-github-apps#generating-a-private-key). +1. Install your GitHub App on the repositories it needs to act upon, optionally you may install the GitHub App on all repositories in your organization. +1. Identify the `installation_id` that represents the connection between your GitHub App and the organization repositories it can access. Each GitHub App and organization pair have at most a single `installation_id`. You can identify this `installation_id` via [Get an organization installation for the authenticated app](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). +1. Generate a server-to-server token using the corresponding REST API endpoint, [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app), and [Authenticating as an installation](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). +1. Use this server-to-server token to interact with your repositories, either via the REST or GraphQL APIs, or via a Git client. -## Usuarios máquina +## Machine users -Si tu servidor necesita acceso a varios repositorios, puedes crear una cuenta nueva en {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} y adjuntar la llave SSH que se utilizará exclusivamente para la automatización. Ya que ningún humano usará esta cuenta en {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}, se denomina _usuario de máquina_. Puede agregar el usuario de máquina como [colaborador][collaborator] en un repositorio personal (y conceder acceso de lectura y escritura), como [colaborador externo][outside-collaborator] en un repositorio de la organización (y conceder acceso de lectura, escritura o administrador), o bien a un [equipo][team] con acceso a los repositorios que necesita automatizar (y conceder los permisos del equipo). +If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). {% ifversion fpt or ghec %} {% tip %} -**Sugerencia:** Nuestros [términos del servicio][tos] establecen que: +**Tip:** Our [terms of service][tos] state: -> *No se permiten cuentas registradas mediante "bots", ni otros métodos automatizados.* +> *Accounts registered by "bots" or other automated methods are not permitted.* -Esto significa que no puedes automatizar la creación de las cuentas. Pero si quieres crear un solo usuario máquina para automatizar las tareas como el despliegue de scripts en tu proyecto u organización, eso está perfecto. +This means that you cannot automate the creation of accounts. But if you want to create a single machine user for automating tasks such as deploy scripts in your project or organization, that is totally cool. {% endtip %} {% endif %} -#### Ventajas +#### Pros -* Cualquiera que tenga acceso al repositorio y al servidor tiene la capacidad de desplegar el proyecto. -* No se necesitan usuarios (humanos) para cambiar su configuración local de SSH. -* No se necesitan llaves múltiples; una por servidor está bien. +* Anyone with access to the repository and server has the ability to deploy the project. +* No (human) users need to change their local SSH settings. +* Multiple keys are not needed; one per server is adequate. -#### Desventajas +#### Cons -* Únicamente las organizaciones pueden restringir a los usuarios máquina para que tengan acceso de solo lectura. Los repositorios personales siempre otorgan a los colaboradores acceso de lectura/escritura. -* Las llaves de los usuarios máquina, tal como las llaves de despliegue, a menudo no se encuentran protegidas con una frase de acceso. +* Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access. +* Machine user keys, like deploy keys, are usually not protected by a passphrase. -#### Configurar +#### Setup -1. [Ejecute el procedimiento `ssh-keygen`][generating-ssh-keys] en el servidor y adjunte la clave pública a la cuenta de usuario de máquina. -2. Otorga a la cuenta del usuario máquina el acceso a los repositorios que quieras automatizar. Para ello, agregue la cuenta como [colaborador][collaborator], como [colaborador externo][outside-collaborator] o a un [equipo][team] de una organización. +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server and attach the public key to the machine user account. +2. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. [ssh-agent-forwarding]: /guides/using-ssh-agent-forwarding/ [generating-ssh-keys]: /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#generating-a-new-ssh-key @@ -192,5 +191,5 @@ Esto significa que no puedes automatizar la creación de las cuentas. Pero si qu [outside-collaborator]: /articles/adding-outside-collaborators-to-repositories-in-your-organization [team]: /articles/adding-organization-members-to-a-team -## Información adicional -- [Configuración de notificaciones](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) diff --git a/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 5125f03909..cf32263771 100644 --- a/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -106,7 +106,7 @@ Activity related to a branch protection rule. For more information, see "[About - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration +- {% data variables.product.prodname_github_apps %} with **Administration** repository permission ### Webhook payload object @@ -161,7 +161,7 @@ Key | Type | Description - Repository webhooks only receive payloads for the `created` and `completed` event types in a repository - Organization webhooks only receive payloads for the `created` and `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. +- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. ### Webhook payload object @@ -185,7 +185,7 @@ Key | Type | Description - Repository webhooks only receive payloads for the `completed` event types in a repository - Organization webhooks only receive payloads for the `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. +- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. ### Webhook payload object @@ -207,7 +207,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `security_events :read` permission +- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission ### Webhook payload object @@ -229,7 +229,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -273,7 +273,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -302,7 +302,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -345,7 +345,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `deployments` permission +- {% data variables.product.prodname_github_apps %} with **Deployments** permission ### Webhook payload object @@ -370,7 +370,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `deployments` permission +- {% data variables.product.prodname_github_apps %} with **Deployments** permission ### Webhook payload object @@ -401,7 +401,7 @@ Activity related to a discussion. For more information, see the "[Using the Grap - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `discussions` permission +- {% data variables.product.prodname_github_apps %} with **Discussions** permission ### Webhook payload object @@ -427,7 +427,7 @@ Activity related to a comment in a discussion. For more information, see "[Using - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `discussions` permission +- {% data variables.product.prodname_github_apps %} with **Discussions** permission ### Webhook payload object @@ -475,7 +475,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -518,7 +518,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -576,7 +576,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `issues` permission +- {% data variables.product.prodname_github_apps %} with **Issues** permission ### Webhook payload object @@ -599,7 +599,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `issues` permission +- {% data variables.product.prodname_github_apps %} with **Issues** permission ### Webhook payload object @@ -622,7 +622,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -673,7 +673,7 @@ For a detailed description of this payload and the payload for each type of `act - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -695,7 +695,7 @@ For a detailed description of this payload and the payload for each type of `act ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -721,7 +721,7 @@ Activity related to merge groups in a merge queue. The type of activity is speci - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `merge_queues` permission +- {% data variables.product.prodname_github_apps %} with **Merge queues** permission ### Webhook payload object @@ -775,7 +775,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -798,7 +798,7 @@ Key | Type | Description {% ifversion ghes or ghae %} - GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} - Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -824,7 +824,7 @@ Key | Type | Description ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `organization_administration` permission +- {% data variables.product.prodname_github_apps %} with **Administration** organization permission ### Webhook payload object @@ -870,7 +870,7 @@ Activity related to {% data variables.product.prodname_registry %}. {% data reus - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pages` permission +- {% data variables.product.prodname_github_apps %} with **Pages** permission ### Webhook payload object @@ -921,7 +921,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -953,7 +953,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -983,7 +983,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -1020,7 +1020,7 @@ Activity related to items in a {% data variables.projects.project_v2 %}. {% data ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** organization permission ### Webhook payload object @@ -1046,7 +1046,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -1073,7 +1073,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1098,7 +1098,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1120,7 +1120,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1143,7 +1143,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1171,7 +1171,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1215,7 +1215,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1236,7 +1236,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends ### Availability -- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload example @@ -1250,7 +1250,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends - Repository webhooks receive all event types except `deleted` - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission receive all event types except `deleted` +- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted` ### Webhook payload object @@ -1319,7 +1319,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission +- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission ### Webhook payload object @@ -1343,7 +1343,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission +- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission ### Webhook payload object @@ -1366,7 +1366,7 @@ The security advisory dataset also powers the GitHub {% data variables.product.p ### Availability -- {% data variables.product.prodname_github_apps %} with the `security_events` permission +- {% data variables.product.prodname_github_apps %} ### Webhook payload object @@ -1391,7 +1391,7 @@ Activity related to enabling or disabling code security and analysis features fo - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration +- {% data variables.product.prodname_github_apps %} with **Administration** repository permission ### Webhook payload object @@ -1464,7 +1464,7 @@ You can only create a sponsorship webhook on {% data variables.product.prodname_ - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `statuses` permission +- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission ### Webhook payload object @@ -1492,7 +1492,7 @@ Key | Type | Description ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -1523,7 +1523,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -1564,7 +1564,7 @@ The event’s actor is the [user](/rest/reference/users) who starred a repositor - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -1585,7 +1585,7 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS ### Availability -- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1634,7 +1634,7 @@ When a {% data variables.product.prodname_actions %} workflow run is requested o ### Availability -- {% data variables.product.prodname_github_apps %} with the `actions` or `contents` permissions. +- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions ### Webhook payload object diff --git a/translations/es-ES/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md b/translations/es-ES/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md index 6059a87772..463ad45f8b 100644 --- a/translations/es-ES/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md +++ b/translations/es-ES/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md @@ -1,6 +1,6 @@ --- -title: Extensiones e integraciones de GitHub -intro: 'Utiliza las extensiones {% data variables.product.product_name %} para trabajar sin inconvenientes en los repositorios {% data variables.product.product_name %} dentro de las aplicaciones de terceros.' +title: GitHub extensions and integrations +intro: 'Use {% data variables.product.product_name %} extensions to work seamlessly in {% data variables.product.product_name %} repositories within third-party applications.' redirect_from: - /articles/about-github-extensions-for-third-party-applications - /articles/github-extensions-and-integrations @@ -10,53 +10,43 @@ versions: fpt: '*' ghec: '*' shortTitle: Extensions & integrations -ms.openlocfilehash: f33ce9b9ae55e523bedff1309f3f2f15202dcf82 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/11/2022 -ms.locfileid: '147884217' --- -## Herramientas del editor +## Editor tools -Puedes conectarte a los repositorios de {% data variables.product.product_name %} dentro de las herramientas de edición de terceros tales como Atom, Unity y {% data variables.product.prodname_vs %}. +You can connect to {% data variables.product.product_name %} repositories within third-party editor tools such as Unity and {% data variables.product.prodname_vs %}. -### {% data variables.product.product_name %} para Atom +### {% data variables.product.product_name %} for Unity -Con el {% data variables.product.product_name %} para la extensión de Atom, puedes confirmar, subir, extraer, resolver conflictos de fusión y mucho más desde el editor de Atom. Para más información, vea el [sitio oficial de {% data variables.product.product_name %} para Atom](https://github.atom.io/). - -### {% data variables.product.product_name %} para Unity - -Con el {% data variables.product.product_name %} para la extensión del editor de Unity, puedes desarrollar en Unity, la plataforma de código abierto de desarrollo de juegos, y ver tu trabajo en {% data variables.product.product_name %}. Para más información, vea el [sitio](https://unity.github.com/) oficial de la extensión del editor de Unity o la [documentación](https://github.com/github-for-unity/Unity/tree/master/docs). +With the {% data variables.product.product_name %} for Unity editor extension, you can develop on Unity, the open source game development platform, and see your work on {% data variables.product.product_name %}. For more information, see the official Unity editor extension [site](https://unity.github.com/) or the [documentation](https://github.com/github-for-unity/Unity/tree/master/docs). ### {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} -Con {% data variables.product.product_name %} para la extensión {% data variables.product.prodname_vs %}, puedes trabajar en repositorios de {% data variables.product.product_name %} sin salir de {% data variables.product.prodname_vs %}. Para obtener más información, consulta el [sitio](https://visualstudio.github.com/) oficial de la extensión de {% data variables.product.prodname_vs %} o la [documentación](https://github.com/github/VisualStudio/tree/master/docs). +With the {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} extension, you can work in {% data variables.product.product_name %} repositories without leaving {% data variables.product.prodname_vs %}. For more information, see the official {% data variables.product.prodname_vs %} extension [site](https://visualstudio.github.com/) or [documentation](https://github.com/github/VisualStudio/tree/master/docs). -### {% data variables.product.prodname_dotcom %} para {% data variables.product.prodname_vscode %} +### {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} -Con {% data variables.product.prodname_dotcom %} para la extensión {% data variables.product.prodname_vscode %}, puedes revisar y administrar solicitudes de incorporación de cambios de {% data variables.product.product_name %} en {% data variables.product.prodname_vscode_shortname %}. Para obtener más información, consulta el [sitio](https://vscode.github.com/) oficial de la extensión de {% data variables.product.prodname_vscode_shortname %} o la [documentación](https://github.com/Microsoft/vscode-pull-request-github). +With the {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} extension, you can review and manage {% data variables.product.product_name %} pull requests in {% data variables.product.prodname_vscode_shortname %}. For more information, see the official {% data variables.product.prodname_vscode_shortname %} extension [site](https://vscode.github.com/) or [documentation](https://github.com/Microsoft/vscode-pull-request-github). -## Herramientas de administración de proyectos +## Project management tools -Puedes integrar tu cuenta organizacional o personal en {% data variables.product.product_location %} con herramientas de administración de proyectos de terceros, tales como Jira. +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party project management tools, such as Jira. -### Integración de Jira Cloud y {% data variables.product.product_name %}.com +### Jira Cloud and {% data variables.product.product_name %}.com integration -Puedes integrar Jira Cloud con tu cuenta personal o de organización para escanear confirmaciones y solicitudes de extracción, y crear los metadatos e hipervínculos correspondientes en cualquiera de las propuestas de Jira mencionadas. Para más información, visite la [aplicación de integración de Jira](https://github.com/marketplace/jira-software-github) en Marketplace. +You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace. -## Herramientas de comunicación para equipos +## Team communication tools -Puedes integrar tu cuenta organizacional o personal en {% data variables.product.product_location %} con herramientas de comunicación de equipos de terceros, tales como Slack o Microsoft Teams. +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party team communication tools, such as Slack or Microsoft Teams. -### Integración con Slack y con {% data variables.product.product_name %} +### Slack and {% data variables.product.product_name %} integration -La aplicación Slack + {% data variables.product.prodname_dotcom %} le permite suscribirse a repositorios u organizaciones, y obtener actualizaciones en tiempo real sobre incidencias, solicitudes de incorporación de cambios, confirmaciones, debates, versiones, revisiones de implementación y estados de implementación. También puede realizar actividades como abrir y cerrar incidencias, y puede ver referencias detalladas a incidencias y solicitudes de incorporación de cambios sin salir de Slack. La aplicación también le hará ping personalmente en Slack si le se menciona como parte de cualquier notificación de {% data variables.product.prodname_dotcom %} que reciba en canales o chats personales. +The Slack + {% data variables.product.prodname_dotcom %} app lets you subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, discussions, releases, deployment reviews and deployment statuses. You can also perform activities like opening and closing issues, and you can see detailed references to issues and pull requests without leaving Slack. The app will also ping you personally in Slack if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. -La aplicación Slack + {% data variables.product.prodname_dotcom %} también es compatible con [Slack Enterprise Grid](https://slack.com/intl/en-in/help/articles/360000281563-Manage-apps-on-Enterprise-Grid). Para más información, visite la [aplicación Slack + {% data variables.product.prodname_dotcom %}](https://github.com/marketplace/slack-github) en Marketplace. +The Slack + {% data variables.product.prodname_dotcom %} app is also compatible with [Slack Enterprise Grid](https://slack.com/intl/en-in/help/articles/360000281563-Manage-apps-on-Enterprise-Grid). For more information, visit the [Slack + {% data variables.product.prodname_dotcom %} app](https://github.com/marketplace/slack-github) in the marketplace. -### Microsoft Teams y su integración con {% data variables.product.product_name %} +### Microsoft Teams and {% data variables.product.product_name %} integration -La aplicación {% data variables.product.prodname_dotcom %} para Teams le permite suscribirse a repositorios u organizaciones, y obtener actualizaciones en tiempo real sobre incidencias, solicitudes de incorporación de cambios, confirmaciones, debates, versiones, revisiones de implementación y estados de implementación. También puede realizar actividades como abrir y cerrar incidencias, comentar incidencias y solicitudes de incorporación de cambios, y puede ver referencias detalladas a incidencias y solicitudes de incorporación de cambios sin salir de Microsoft Teams. La aplicación también le hará ping personalmente en Teams si le se menciona como parte de cualquier notificación de {% data variables.product.prodname_dotcom %} que reciba en canales o chats personales. +The {% data variables.product.prodname_dotcom %} for Teams app lets you subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, discussions, releases, deployment reviews and deployment statuses. You can also perform activities like opening and closing issues, commenting on your issues and pull requests, and you can see detailed references to issues and pull requests without leaving Microsoft Teams. The app will also ping you personally in Teams if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. -Para más información, visite la [aplicación {% data variables.product.prodname_dotcom %} para Teams](https://appsource.microsoft.com/en-us/product/office/WA200002077) en Microsoft AppSource. +For more information, visit the [{% data variables.product.prodname_dotcom %} for Teams app](https://appsource.microsoft.com/en-us/product/office/WA200002077) in Microsoft AppSource. diff --git a/translations/es-ES/content/get-started/getting-started-with-git/associating-text-editors-with-git.md b/translations/es-ES/content/get-started/getting-started-with-git/associating-text-editors-with-git.md index 988f79addf..37d6192f7a 100644 --- a/translations/es-ES/content/get-started/getting-started-with-git/associating-text-editors-with-git.md +++ b/translations/es-ES/content/get-started/getting-started-with-git/associating-text-editors-with-git.md @@ -1,6 +1,6 @@ --- -title: Asociar editores de texto con Git -intro: Usar un editor de texto para abrir y editar tus archivos con Git. +title: Associating text editors with Git +intro: Use a text editor to open and edit your files with Git. redirect_from: - /textmate - /articles/using-textmate-as-your-default-editor @@ -15,48 +15,33 @@ versions: ghae: '*' ghec: '*' shortTitle: Associate text editors -ms.openlocfilehash: 0d02c32ff04d4a5a2a1003464175e866630603f4 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/11/2022 -ms.locfileid: '145148763' --- {% mac %} -## Usar Atom como editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Instale [Atom](https://atom.io/). Para más información, vea "[Instalación de Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" en la documentación de Atom. +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## Uso de {% data variables.product.prodname_vscode %} como editor - -1. Instala [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). Para obtener más información, consulta la documentación de {% data variables.product.prodname_vscode_shortname %}, la sección "[Configuración de {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)". -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## Usar Sublime Text como editor +## Using Sublime Text as your editor -1. Instale [Sublime Text](https://www.sublimetext.com/). Para obtener más información, vea "[Instalación](https://docs.sublimetext.io/guide/getting-started/installation.html)" en la documentación de Sublime Text. +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: +3. Type this command: ```shell $ git config --global core.editor "subl -n -w" ``` -## Usar TextMate como editor +## Using TextMate as your editor -1. Instale [TextMate](https://macromates.com/). -2. Instale la utilidad de shell `mate` de TextMate. Para obtener más información, vea "[`mate` y `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)" en la documentación de TextMate. +1. Install [TextMate](https://macromates.com/). +2. Install TextMate's `mate` shell utility. For more information, see "[`mate` and `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)" in the TextMate documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -4. Escriba el siguiente comando: +4. Type this command: ```shell $ git config --global core.editor "mate -w" ``` @@ -64,38 +49,29 @@ ms.locfileid: '145148763' {% windows %} -## Usar Atom como editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Instale [Atom](https://atom.io/). Para más información, vea "[Instalación de Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" en la documentación de Atom. +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## Uso de {% data variables.product.prodname_vscode %} como editor - -1. Instala [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). Para obtener más información, consulta la documentación de {% data variables.product.prodname_vscode_shortname %}, la sección "[Configuración de {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)". -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## Usar Sublime Text como editor +## Using Sublime Text as your editor -1. Instale [Sublime Text](https://www.sublimetext.com/). Para obtener más información, vea "[Instalación](https://docs.sublimetext.io/guide/getting-started/installation.html)" en la documentación de Sublime Text. +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: +3. Type this command: ```shell $ git config --global core.editor "'C:/Program Files (x86)/sublime text 3/subl.exe' -w" ``` -## Usar Notepad++ como editor +## Using Notepad++ as your editor -1. Instale Notepad++ desde https://notepad-plus-plus.org/. Para obtener más información, vea "[Introducción](https://npp-user-manual.org/docs/getting-started/)" en la documentación de Notepad++. +1. Install Notepad++ from https://notepad-plus-plus.org/. For more information, see "[Getting started](https://npp-user-manual.org/docs/getting-started/)" in the Notepad++ documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: +3. Type this command: ```shell $ git config --global core.editor "'C:/Program Files (x86)/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin" ``` @@ -103,29 +79,20 @@ ms.locfileid: '145148763' {% linux %} -## Usar Atom como editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Instale [Atom](https://atom.io/). Para más información, vea "[Instalación de Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" en la documentación de Atom. +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## Uso de {% data variables.product.prodname_vscode %} como editor - -1. Instala [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). Para obtener más información, consulta la documentación de {% data variables.product.prodname_vscode_shortname %}, la sección "[Configuración de {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)". -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## Usar Sublime Text como editor +## Using Sublime Text as your editor -1. Instale [Sublime Text](https://www.sublimetext.com/). Para obtener más información, vea "[Instalación](https://docs.sublimetext.io/guide/getting-started/installation.html)" en la documentación de Sublime Text. +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Escriba el siguiente comando: +3. Type this command: ```shell $ git config --global core.editor "subl -n -w" ``` diff --git a/translations/es-ES/content/get-started/index.md b/translations/es-ES/content/get-started/index.md index fab3f730b7..24260a414b 100644 --- a/translations/es-ES/content/get-started/index.md +++ b/translations/es-ES/content/get-started/index.md @@ -32,6 +32,7 @@ featuredLinks: - /get-started/onboarding/getting-started-with-github-enterprise-cloud - /get-started/onboarding/getting-started-with-github-enterprise-server - /get-started/onboarding/getting-started-with-github-ae + - /get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github popular: - /github/getting-started-with-github/signing-up-for-a-new-github-account - /get-started/quickstart/hello-world diff --git a/translations/es-ES/content/get-started/quickstart/communicating-on-github.md b/translations/es-ES/content/get-started/quickstart/communicating-on-github.md index bdbdcf0de4..746d67c59d 100644 --- a/translations/es-ES/content/get-started/quickstart/communicating-on-github.md +++ b/translations/es-ES/content/get-started/quickstart/communicating-on-github.md @@ -1,6 +1,6 @@ --- -title: Comunicarse en GitHub -intro: 'Puedes debatir cambios y proyectos específicos, así como metas de equipo o ideas más amplias, usando tipos diferentes de debates en {% data variables.product.product_name %}.' +title: Communicating on GitHub +intro: 'You can discuss specific projects and changes, as well as broader ideas or team goals, using different types of discussions on {% data variables.product.product_name %}.' miniTocMaxHeadingLevel: 3 redirect_from: - /github/collaborating-with-issues-and-pull-requests/getting-started/quickstart-for-communicating-on-github @@ -18,137 +18,137 @@ topics: - Issues - Discussions - Fundamentals -ms.openlocfilehash: 6c7461a01cd0bc44bff93b1eb4e8a013d26bc147 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147408895' --- -## Introducción +## Introduction -{% data variables.product.product_name %} proporciona herramientas de comunicación colaborativas que te permiten interactuar de cerca con tu comunidad. Esta guía de inicio rápido te mostrará cómo escoger la herramienta correcta para tus necesidades. +{% data variables.product.product_name %} provides built-in collaborative communication tools allowing you to interact closely with your community. This quickstart guide will show you how to pick the right tool for your needs. -{% ifversion discussions %} Puedes crear y participar en propuestas, solicitudes de cambios, {% data variables.product.prodname_discussions %} y debates de equipo, dependiendo del tipo de conversación que te gustaría tener. -{% else %} Puedes crear y participar en propuestas, solicitudes de extracción y debates de equipos, dependiendo del tipo de conversación que quieras tener. +{% ifversion discussions %} +You can create and participate in issues, pull requests, {% data variables.product.prodname_discussions %}, and team discussions, depending on the type of conversation you'd like to have. +{% else %} +You can create and participate in issues, pull requests and team discussions, depending on the type of conversation you'd like to have. {% endif %} ### {% data variables.product.prodname_github_issues %} -- son útiles para debatir los detalles específicos de un proyecto, tales como los reportes de errores, mejoras planeadas y retroalimentación. -- son específicas de un repositorio y, habitualmente, es claro quién es el propietario. -- a menudo se refiere a ellas como el sistema de rastreo de errores de {% data variables.product.prodname_dotcom %}. +- are useful for discussing specific details of a project such as bug reports, planned improvements and feedback. +- are specific to a repository, and usually have a clear owner. +- are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system. -### Solicitudes de incorporación de cambios -- te permiten proponer cambios específicos. -- te permiten comentar directamente en los cambios propuestos que otros sugieren. -- son específicos para un repositorio. +### Pull requests +- allow you to propose specific changes. +- allow you to comment directly on proposed changes suggested by others. +- are specific to a repository. {% ifversion fpt or ghec %} ### {% data variables.product.prodname_discussions %} -- son como un foro y son muy útiles para ideas y debates abiertos en donde es importante la colaboración. -- pueden abarcar muchos repositorios. -- proporcionan una experiencia colaborativa fuera de la base de código, lo cual permite la lluvia de ideas y la creación de una base de conocimiento comunitario. -- a menudo no se sabe quién es el propietario. -- a menudo no dan como resultado una tarea sobre la cual se pueda actuar. +- are like a forum, and are best used for open-form ideas and discussions where collaboration is important. +- may span many repositories. +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base. +- often don’t have a clear owner. +- often do not result in an actionable task. {% endif %} -### Discusiones de equipo -- pueden iniciarse en la página de tu equipo para tener conversaciones que abarquen varios proyectos y no pertenecen solo a una propuesta o solicitud de cambios específicas. En vez de abrir un informe de problemas en un repositorio para debatir sobre una idea, puedes incluir a todo el equipo si tienes una conversación en un debate de equipo. -- te permiten mantener debates con tu equipo sobre planeación, análisis, diseño, investigación de usuarios y toma de decisiones generales de un proyecto, todo en un solo lugar.{% ifversion ghes or ghae %} -- proporcionan una experiencia colaborativa fuera de la base de código, lo cual permite la lluvia de ideas. -- a menudo no se sabe quién es el propietario. -- a menudo no dan como resultad una tarea sobre la cual se pueda actuar.{% endif %} +### Team discussions +- can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion. +- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes or ghae %} +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas. +- often don’t have a clear owner. +- often do not result in an actionable task.{% endif %} -## ¿Qué debate debo utilizar? +## Which discussion tool should I use? -### Casos de las propuestas +### Scenarios for issues -- Quiero dar seguimiento a las tareas, ampliaciones y errores. -- Quiero emitir un reporte de errores. -- Quiero compartir retroalimentación sobre una característica específica. -- Quiero hacer una pregunta sobre los archivos del repositorio. +- I want to keep track of tasks, enhancements and bugs. +- I want to file a bug report. +- I want to share feedback about a specific feature. +- I want to ask a question about files in the repository. -#### Ejemplo de propuesta +#### Issue example -Este ejemplo demuestra cómo un usuario de {% data variables.product.prodname_dotcom %} creó una propuesta en nuestro repositorio de documentación de código abierto para concientizarnos de un error y debatir sobre cómo arreglarlo. +This example illustrates how a {% data variables.product.prodname_dotcom %} user created an issue in our documentation open source repository to make us aware of a bug, and discuss a fix. -![Ejemplo de propuesta](/assets/images/help/issues/issue-example.png) +![Example of issue](/assets/images/help/issues/issue-example.png) -- Un usuario notó que el color azul del letrero en la parte superior de la página de la versión china de los documentos de {% data variables.product.prodname_dotcom %} hace que el texto contenido sea ilegible. -- El usurio creó una propuesta en el repositorio, la cual declaraba el problema y sugería un arreglo (el cual es utilizar un color de fondo diferente para el letrero). -- Se produce un debate y, periódicamente, se llega a un consenso sobre qué solución aplicar. -- Entonces, un colaborador puede crear una solicitud de cambios con la solución. +- A user noticed that the blue color of the banner at the top of the page in the Chinese version of the {% data variables.product.prodname_dotcom %} Docs makes the text in the banner unreadable. +- The user created an issue in the repository, stating the problem and suggesting a fix (which is, use a different background color for the banner). +- A discussion ensues, and eventually, a consensus will be reached about the fix to apply. +- A contributor can then create a pull request with the fix. -### Escenarios para solicitudes de cambios +### Scenarios for pull requests -- Quiero arreglar un error tipográcifo en un repositorio. -- Quiero hacer cambios en un repositorio. -- Quiero hacer cambios para corregir un error. -- Quiero comentar en los cambios que otros sugieren. +- I want to fix a typo in a repository. +- I want to make changes to a repository. +- I want to make changes to fix an issue. +- I want to comment on changes suggested by others. -#### Ejemplo de solicitud de incorporación de cambios +#### Pull request example -Este ejemplo ilustra cómo un usuario de {% data variables.product.prodname_dotcom %} creó una solicitud de cambios en el repositorio de código abierto de nuestra documentación para arreglar un error tipográfico. +This example illustrates how a {% data variables.product.prodname_dotcom %} user created a pull request in our documentation open source repository to fix a typo. -En la pestaña **Conversación** de la solicitud de incorporación de cambios, el autor explica por qué ha creado la solicitud de incorporación de cambios. +In the **Conversation** tab of the pull request, the author explains why they created the pull request. -![Ejemplo de solicitud de cambios - Pestaña de conversación](/assets/images/help/pull_requests/pr-conversation-example.png) +![Example of pull request - Conversation tab](/assets/images/help/pull_requests/pr-conversation-example.png) -La pestaña **Archivos cambiados** de la solicitud de incorporación de cambios muestra la corrección implementada. +The **Files changed** tab of the pull request shows the implemented fix. -![Ejemplo de solicitud de cambios - Pestaña de archivos que cambiaron](/assets/images/help/pull_requests/pr-files-changed-example.png) +![Example of pull request - Files changed tab](/assets/images/help/pull_requests/pr-files-changed-example.png) -- Este contribuyente nota un error tipográfico en el repositorio. -- El usuario crea una solicitud de cambios con la solución. -- Un mantenedor de repositorio revisa la solicitud de cambios, la comenta y la fusiona. +- This contributor notices a typo in the repository. +- The user creates a pull request with the fix. +- A repository maintainer reviews the pull request, comments on it, and merges it. {% ifversion discussions %} -### Casos para los {% data variables.product.prodname_discussions %} +### Scenarios for {% data variables.product.prodname_discussions %} -- Tengo una pregunta que no se relaciona necesariamente con los archivos específicos del repositorio. -- Quiero compartir las noticias con mis colaboradores o con mi equipo. -- Quiero comenzar o participar en una conversación abierta. -- Quiero hacer un anuncio a mi comunidad. +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my community. -#### Ejemplo de {% data variables.product.prodname_discussions %} +#### {% data variables.product.prodname_discussions %} example -Este ejemplo muestra la publicación de bienvenida de {% data variables.product.prodname_discussions %} para el repositorio de código abierto de los documentos de {% data variables.product.prodname_dotcom %} e ilustra cómo el equipo quiere colaborar con su comunidad. +This example shows the {% data variables.product.prodname_discussions %} welcome post for the {% data variables.product.prodname_dotcom %} Docs open source repository, and illustrates how the team wants to collaborate with their community. -![Ejemplo de un {% data variables.product.prodname_discussions %}](/assets/images/help/discussions/github-discussions-example.png) +![Example of {% data variables.product.prodname_discussions %}](/assets/images/help/discussions/github-discussions-example.png) -El mantenedor de la comunidad inició un debate para recibir a la comunidad y para pedir a los miembros que se presentaran a sí mismos. Esta publicación fomenta un ambiente acogedor para los visitantes y contribuyentes. Esta publicación también aclara que al equipo le complace ayudar a los contribuyentes del repositorio. +This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository. {% endif %} -### Casos de debates de equipo +### Scenarios for team discussions -- Tengo una pregunta que no se relaciona necesariamente con los archivos específicos del repositorio. -- Quiero compartir las noticias con mis colaboradores o con mi equipo. -- Quiero comenzar o participar en una conversación abierta. -- Quiero anunciar algo a mi equipo. +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my team. -{% ifversion fpt or ghec %} Como puedes ver, los debates de equipo son muy similares a los {% data variables.product.prodname_discussions %}. Para {% data variables.product.prodname_dotcom_the_website %}, te recomendamos utilizar los {% data variables.product.prodname_discussions %} como inicio de conversaciones. Puedes utilizar los {% data variables.product.prodname_discussions %} para colaborar con cualquier comunidad en {% data variables.product.prodname_dotcom %}. Si eres parte de una organización y te gustaría iniciar conversaciones dentro de tu organización o del equipo que está dentro de ella, debes utilizar los debates de equipo. +{% ifversion fpt or ghec %} +As you can see, team discussions are very similar to {% data variables.product.prodname_discussions %}. For {% data variables.product.prodname_dotcom_the_website %}, we recommend using {% data variables.product.prodname_discussions %} as the starting point for conversations. You can use {% data variables.product.prodname_discussions %} to collaborate with any community on {% data variables.product.prodname_dotcom %}. If you are part of an organization, and would like to initiate conversations within your organization or team within that organization, you should use team discussions. {% endif %} -#### Ejemplo de debates de equipo +#### Team discussion example -En este ejemplo se muestra una publicación de equipo para el equipo `octo-team`. +This example shows a team post for the `octo-team` team. -![Ejemplo de debate de equipo](/assets/images/help/projects/team-discussions-example.png) +![Example of team discussion](/assets/images/help/projects/team-discussions-example.png) -El miembro del equipo `octocat` publicó un debate de equipo e informó al equipo de varias cosas: -- Un miembro del equipo llamado Mona inició eventos de juego remotos. -- Hay una publicación del blog que describe cómo los equipos utilizan {% data variables.product.prodname_actions %} para producir sus documentos. -- Los materiales sobre el "All Hands" de abril está ahora disponible para que lo vean todos los miembros del equipo. +The `octocat` team member posted a team discussion, informing the team of various things: +- A team member called Mona started remote game events. +- There is a blog post describing how the teams use {% data variables.product.prodname_actions %} to produce their docs. +- Material about the April All Hands is now available for all team members to view. -## Pasos siguientes +## Next steps -Estos ejemplos te muestran cómo decidir cuál es la mejor herramienta para tus conversaciones en {% data variables.product.product_name %}. Pero esto es solo el inicio; puedes hacer mucho más para confeccionar estas herramientas de acuerdo con tus necesidades. +These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs. -Para las propuestas, por ejemplo, puedes etiquetarlas con etiquetas para buscarlas más rápidamente y crear plantillas de propuesta para ayudar a los contribuyentes a abrir propuestas significativas. Para obtener más información, consulta "[Acerca de las propuestas](/github/managing-your-work-on-github/about-issues#working-with-issues)" y "[Acerca de las plantillas de propuestas y solicitudes de incorporación de cambios](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)". +For issues, for example, you can tag issues with labels for quicker searching and create issue templates to help contributors open meaningful issues. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues#working-with-issues)" and "[About issue and pull request templates](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." -Para las solicitudes de cambio, puedes crear borradores de estas si los cambios que propones aún están en curso. Los borradores de solicitudes de cambios no pueden fusionarse hasta que se marquen como listos para revisión. Para más información, vea "[Acerca de las solicitudes de incorporación de cambios](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)". +For pull requests, you can create draft pull requests if your proposed changes are still a work in progress. Draft pull requests cannot be merged until they're marked as ready for review. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)." -{% ifversion discussions %} Para el caso de los {% data variables.product.prodname_discussions %}, puedes{% ifversion fpt or ghec %} configurar un código de conducta y{% endif %} fijar los debates que contengan información importante de tu comunidad. Para más información, vea "[Acerca de los debates](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". +{% ifversion discussions %} +For {% data variables.product.prodname_discussions %}, you can{% ifversion fpt or ghec %} set up a code of conduct and{% endif %} pin discussions that contain important information for your community. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} -Para el caso de los debates de equipo, puedes editarlos o borrarlos en la página del equipo y puedes configurar las notificaciones para estos. Para obtener más información, consulta "[Acerca de los debates de equipo](/organizations/collaborating-with-your-team/about-team-discussions)". +For team discussions, you can edit or delete discussions on a team's page, and you can configure notifications for team discussions. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." + +To learn some advanced formatting features that will help you communicate, see "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)." \ No newline at end of file diff --git a/translations/es-ES/content/get-started/quickstart/git-and-github-learning-resources.md b/translations/es-ES/content/get-started/quickstart/git-and-github-learning-resources.md index ebbf719af4..a4f544484c 100644 --- a/translations/es-ES/content/get-started/quickstart/git-and-github-learning-resources.md +++ b/translations/es-ES/content/get-started/quickstart/git-and-github-learning-resources.md @@ -1,12 +1,12 @@ --- -title: Recursos de aprendizaje de Git y GitHub +title: Git and GitHub learning resources redirect_from: - /articles/good-resources-for-learning-git-and-github - /articles/what-are-other-good-resources-for-learning-git-and-github - /articles/git-and-github-learning-resources - /github/getting-started-with-github/git-and-github-learning-resources - /github/getting-started-with-github/quickstart/git-and-github-learning-resources -intro: 'Hay muchos recursos útiles de Git y {% data variables.product.product_name %} disponibles en la web. La siguientes es una pequeña lista de nuestros favoritos.' +intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources on the web. This is a short list of our favorites!' versions: fpt: '*' ghes: '*' @@ -15,55 +15,49 @@ versions: authors: - GitHub shortTitle: Learning resources -ms.openlocfilehash: d8d0457de2842392febee0c90660285e9b1afef8 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146139300' --- -## Utilizar GitHub +## Using Git -Para familiarizarse con Git, visite el [sitio oficial del proyecto de Git](https://git-scm.com) y lea el [libro ProGit](http://git-scm.com/book). También puedes revisar la [lista de comandos de Git](https://git-scm.com/docs). +Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs). -## Uso de {% data variables.product.product_name %} +## Using {% data variables.product.product_name %} {% ifversion fpt or ghec %} -{% data variables.product.prodname_learning %} ofrece cursos interactivos gratuitos integrados en {% data variables.product.prodname_dotcom %} con evaluación y asistencia instantáneas y automatizadas. Aprende a abrir tu primera solicitud de extracción, hacer tu primera contribución de código abierto, crear un sitio {% data variables.product.prodname_pages %}, y mucho más. Para más información sobre las ofertas de cursos, vea [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). +{% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). {% endif %} -Familiarícese mejor con {% data variables.product.product_name %} con ayuda de nuestros artículos de [introducción](/categories/getting-started-with-github/). Vea nuestro [flujo de {% data variables.product.prodname_dotcom %}](https://guides.github.com/introduction/flow) para obtener una introducción al proceso. Consulte nuestras [guías de información general](https://guides.github.com) para examinar los conceptos básicos. +Become better acquainted with {% data variables.product.product_name %} through our [getting started](/categories/getting-started-with-github/) articles. See our [{% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow) for a process introduction. Refer to our [overview guides](https://guides.github.com) to walk through basic concepts. {% data reusables.support.ask-and-answer-forum %} -### Ramas, bifurcaciones y solicitudes de extracción +### Branches, forks, and pull requests -Obtenga información sobre la [creación de ramas de Git](http://learngitbranching.js.org/) mediante una herramienta interactiva. Obtenga información sobre [bifurcaciones](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) y [solicitudes de incorporación de cambios](/articles/using-pull-requests), y [sobre cómo usamos solicitudes de incorporación de cambios](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) en {% data variables.product.prodname_dotcom %}. Acceda a referencias sobre el uso de {% data variables.product.prodname_dotcom %} desde la [línea de comandos](https://cli.github.com/). +Learn about [Git branching](http://learngitbranching.js.org/) using an interactive tool. Read about [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) and [pull requests](/articles/using-pull-requests) as well as [how we use pull requests](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) at {% data variables.product.prodname_dotcom %}. Access references about using {% data variables.product.prodname_dotcom %} from the [command line](https://cli.github.com/). -### Ponte al día +### Tune in -En nuestro [canal de aprendizaje y guías en YouTube](https://youtube.com/githubguides) de {% data variables.product.prodname_dotcom %} se ofrecen tutoriales sobre [solicitudes de incorporación de cambios](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [bifurcaciones](https://www.youtube.com/watch?v=5oJHRbqEofs), [fusión mediante cambio de base](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22) y [restablecimiento](https://www.youtube.com/watch?v=BKPjPMVB81g) de funciones. Cada tema se cubre en menos de 5 minutos. +Our {% data variables.product.prodname_dotcom %} [YouTube Training and Guides channel](https://youtube.com/githubguides) offers tutorials about [pull requests](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [forking](https://www.youtube.com/watch?v=5oJHRbqEofs), [rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22), and [reset](https://www.youtube.com/watch?v=BKPjPMVB81g) functions. Each topic is covered in 5 minutes or less. -## Cursos +## Training -### Cursos gratuitos +### Free courses -{% data variables.product.product_name %} ofrece una serie de [cursos de aprendizaje a petición](https://skills.github.com/) e interactivos, como [Introducción a {% data variables.product.prodname_dotcom %}](https://github.com/skills/introduction-to-github), y cursos herramientas específicas de {% data variables.product.product_name %}, como {% data variables.product.prodname_actions %}. +{% data variables.product.product_name %} offers a series of interactive, [on-demand training courses](https://skills.github.com/) including [Introduction to {% data variables.product.prodname_dotcom %}](https://github.com/skills/introduction-to-github); and courses on {% data variables.product.product_name %} specific tools such as {% data variables.product.prodname_actions %}. -### Programas educativos basados en la web de {% data variables.product.prodname_dotcom %} +### {% data variables.product.prodname_dotcom %}'s web-based educational programs -{% data variables.product.prodname_dotcom %} ofrece [entrenamientos](https://services.github.com/#upcoming-events) en directo con un enfoque práctico basado en proyectos para los usuarios a los que les encanta la línea de comandos y a los que no. +{% data variables.product.prodname_dotcom %} offers live [trainings](https://services.github.com/#upcoming-events) with a hands-on, project-based approach for those who love the command line and those who don't. -### Capacitación para tu compañía +### Training for your company -{% data variables.product.prodname_dotcom %} ofrece [clases presenciales](https://services.github.com/#offerings) impartidas por formadores altamente experimentados. [Póngase en contacto con nosotros](https://services.github.com/#contact) para formular sus preguntas relacionadas con el entrenamiento. +{% data variables.product.prodname_dotcom %} offers [in-person classes](https://services.github.com/#offerings) taught by our highly-experienced educators. [Contact us](https://services.github.com/#contact) to ask your training-related questions. ## Extras -Un [curso de Git en línea](https://www.pluralsight.com/courses/code-school-git-real) interactivo de [Pluralsight](https://www.pluralsight.com/codeschool) tiene siete niveles con docenas de ejercicios en un formato de juego divertido. No dude en adaptar nuestras [plantillas de .gitignore](https://github.com/github/gitignore) para adecuarlas a sus necesidades. +An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) has seven levels with dozens of exercises in a fun game format. Feel free to adapt our [.gitignore templates](https://github.com/github/gitignore) to meet your needs. -Amplíe los conocimientos sobre {% data variables.product.prodname_dotcom %} mediante {% ifversion fpt or ghec %}[integraciones](/articles/about-integrations){% else %}integraciones{% endif %}, o bien con la instalación de [{% data variables.product.prodname_desktop %}](https://desktop.github.com) y el sólido editor de texto [Atom](https://atom.io). +Extend your {% data variables.product.prodname_dotcom %} reach through {% ifversion fpt or ghec %}[integrations](/articles/about-integrations){% else %}integrations{% endif %}, or by installing [{% data variables.product.prodname_desktop %}](https://desktop.github.com) and the robust [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) text editor. -Obtenga información sobre cómo iniciar y aumentar el proyecto de código abierto con las [Guías de código abierto](https://opensource.guide/). +Learn how to launch and grow your open source project with the [Open Source Guides](https://opensource.guide/). diff --git a/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md b/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md index 60e656b9ed..ffec457383 100644 --- a/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md +++ b/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md @@ -1,6 +1,6 @@ --- -title: Acerca de escritura y formato en GitHub -intro: GitHub combina una sintáxis para el texto con formato llamado formato Markdown de GitHub con algunas características de escritura únicas. +title: About writing and formatting on GitHub +intro: GitHub combines a syntax for formatting text called GitHub Flavored Markdown with a few unique writing features. redirect_from: - /articles/about-writing-and-formatting-on-github - /github/writing-on-github/about-writing-and-formatting-on-github @@ -10,40 +10,36 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Write & format on GitHub -ms.openlocfilehash: 7819ebc6bbf3ffa8696c87f82745a19c103c8134 -ms.sourcegitcommit: 478f2931167988096ae6478a257f492ecaa11794 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/09/2022 -ms.locfileid: '147860838' +shortTitle: About writing & formatting --- -[Markdown](http://daringfireball.net/projects/markdown/) es una sintaxis fácil de leer y escribir para dar formato al texto sin formato. +[Markdown](http://daringfireball.net/projects/markdown/) is an easy-to-read, easy-to-write syntax for formatting plain text. -Le hemos agregado alguna funcionalidad personalizada para crear el formato Markdown de {% data variables.product.prodname_dotcom %}, usado para dar formato a la prosa y al código en todo nuestro sitio. +We've added some custom functionality to create {% data variables.product.prodname_dotcom %} Flavored Markdown, used to format prose and code across our site. -También puede interactuar con otros usuarios en solicitudes de incorporación de cambios e incidencias mediante características como [@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), [referencias de incidencia y PR](/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests), y [emoji](/articles/basic-writing-and-formatting-syntax/#using-emoji). +You can also interact with other users in pull requests and issues using features like [@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), [issue and PR references](/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests), and [emoji](/articles/basic-writing-and-formatting-syntax/#using-emoji). -## Barra de herramientas de formato de texto +## Text formatting toolbar -Cada campo de comentario en {% data variables.product.product_name %} contiene una barra de herramientas de formato de texto, lo que te permite dar formato a tu texto sin tener que aprender la sintáxis de Markdown. Además del formato de Markdown como los estilos de negrita y cursiva, y la creación de encabezados, enlaces y listas, la barra de herramientas incluye características específicas de {% data variables.product.product_name %}, como @mentions, listados de tareas y vínculos a incidencias y solicitudes de incorporación de cambios. +Every comment field on {% data variables.product.product_name %} contains a text formatting toolbar, allowing you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.product_name %}-specific features such as @mentions, task lists, and links to issues and pull requests. {% ifversion fixed-width-font-gfm-fields %} -## Habilitar fuentes de ancho fijo en el editor +## Enabling fixed-width fonts in the editor -Puedes habilitar las fuentes de ancho fijo en cada campo de comentario de {% data variables.product.product_name %}. Cada carácter en una fuente de ancho fijo o de monoespacio ocupa el mismo espacio horizontal, lo cual hace más fácil la edición de las estructuras de lenguaje de marcado, tales como tablas y fragmentos de código. +You can enable a fixed-width font in every comment field on {% data variables.product.product_name %}. Each character in a fixed-width, or monospace, font occupies the same horizontal space which can make it easier to edit advanced Markdown structures such as tables and code snippets. -![Captura de pantalla que muestra el campo de comentario de {% data variables.product.product_name %} con fuentes de ancho fijo habilitadas](/assets/images/help/writing/fixed-width-example.png) +![Screenshot showing the {% data variables.product.product_name %} comment field with fixed-width fonts enabled](/assets/images/help/writing/fixed-width-example.png) -{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.appearance-settings %} -1. En "Preferencia de fuente del editor de Markdown", seleccione **Usar una fuente de ancho fijo (monoespacial) al editar Markdown**. - ![Captura de pantalla en la que se muestra el campo de comentario de {% data variables.product.product_name %} con fuentes de ancho fijo habilitadas](/assets/images/help/writing/enable-fixed-width.png) +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.appearance-settings %} +1. Under "Markdown editor font preference", select **Use a fixed-width (monospace) font when editing Markdown**. + ![Screenshot showing the {% data variables.product.product_name %} comment field with fixed width fonts enabled](/assets/images/help/writing/enable-fixed-width.png) {% endif %} -## Información adicional +## Further reading -- [Especificación de {% data variables.product.prodname_dotcom %} Flavored Markdown](https://github.github.com/gfm/) -- "[Sintaxis de escritura y formato básicos](/articles/basic-writing-and-formatting-syntax)" -- "[Trabajo con el formato avanzado](/articles/working-with-advanced-formatting)" +- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) +- "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)" +- "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)" diff --git a/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index a7321a27c9..b229b71ca3 100644 --- a/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -179,13 +179,7 @@ You can specify the theme an image is displayed for in Markdown by using the HTM For example, the following code displays a sun image for light themes and a moon for dark themes: -```HTML - - - - Shows an illustrated sun in light color mode and a moon with stars in dark color mode. - -``` +{% data reusables.getting-started.picture-element-example %} The old method of specifying images based on the theme, by using a fragment appended to the URL (`#gh-dark-mode-only` or `#gh-light-mode-only`), is deprecated and will be removed in favor of the new method described above. {% endif %} @@ -216,7 +210,7 @@ To order your list, precede each line with a number. You can create a nested list by indenting one or more list items below another item. -To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [Atom](https://atom.io/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (- or *) lies directly below the first character of the text in the item above it. +To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (- or *) lies directly below the first character of the text in the item above it. ```markdown 1. First list item @@ -394,3 +388,4 @@ For more information, see Daring Fireball's "[Markdown Syntax](https://daringfir - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) - "[About writing and formatting on GitHub](/articles/about-writing-and-formatting-on-github)" - "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)" diff --git a/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md b/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md index 2e4af5fa79..eb38623d00 100644 --- a/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md +++ b/translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md @@ -12,6 +12,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart-for-writing-on-github - /about-writing-and-formatting-on-github - /basic-writing-and-formatting-syntax shortTitle: Start writing on GitHub diff --git a/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 44fc59d190..5e9fa6ecc4 100644 --- a/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/translations/es-ES/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,8 +70,8 @@ You can find the node ID of an organization project if you know the organization ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -79,8 +79,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION"){ - projectV2(number: NUMBER) { + organization(login: "ORGANIZATION"){ + projectV2(number: NUMBER) { id } } @@ -94,8 +94,8 @@ You can also find the node ID of all projects in your organization. The followin ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{organization(login: \"ORGANIZATION") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -103,7 +103,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION") { + organization(login: "ORGANIZATION") { projectsV2(first: 20) { nodes { id @@ -125,8 +125,8 @@ You can find the node ID of a user project if you know the project number. Repla ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -134,8 +134,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER"){ - projectV2(number: NUMBER) { + user(login: "USER"){ + projectV2(number: NUMBER) { id } } @@ -149,8 +149,8 @@ You can also find the node ID for all of your projects. The following example wi ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -158,7 +158,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER") { + user(login: "USER") { projectsV2(first: 20) { nodes { id @@ -180,8 +180,8 @@ The following example will return the ID, name, settings, and configuration for ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -189,7 +189,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -284,8 +284,8 @@ If you just need the name and ID of a field, and do not need information about i ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -293,7 +293,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -354,8 +354,8 @@ The following example will return the first 20 issues, pull requests, and draft ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -363,7 +363,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { items(first: 20) { nodes{ @@ -446,8 +446,8 @@ The following example will add an issue or pull request to your project. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -455,7 +455,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { + addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { item { id } @@ -488,8 +488,8 @@ The following example will add a draft issue to your project. Replace `PROJECT_I ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: \"PROJECT_ID\" title: \"TITLE\" body: \"BODY\"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -497,7 +497,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { + addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { projectItem { id } @@ -528,8 +528,8 @@ The following example will update your project's settings. Replace `PROJECT_ID` ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: Bearer TOKEN' \ ---data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' +--header 'Authorization: Bearer TOKEN' \ +--data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -539,7 +539,7 @@ gh api graphql -f query=' mutation { updateProjectV2( input: { - projectId: "PROJECT_ID", + projectId: "PROJECT_ID", title: "Project title", public: false, readme: "# Project README\n\nA long description", @@ -565,8 +565,8 @@ The following example will update the value of a text field for an item. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -576,9 +576,9 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { text: "Updated text" } @@ -619,8 +619,8 @@ The following example will update the value of a single select field for an item ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -630,11 +630,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - singleSelectOptionId: "OPTION_ID" + singleSelectOptionId: "OPTION_ID" } } ) { @@ -659,8 +659,8 @@ The following example will update the value of an iteration field for an item. ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -670,11 +670,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - iterationId: "ITERATION_ID" + iterationId: "ITERATION_ID" } } ) { @@ -694,8 +694,8 @@ The following example will delete an item from a project. Replace `PROJECT_ID` w ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} @@ -705,8 +705,8 @@ gh api graphql -f query=' mutation { deleteProjectV2Item( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" } ) { deletedItemId diff --git a/translations/es-ES/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md b/translations/es-ES/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md index aae7367309..adbebde7ee 100644 --- a/translations/es-ES/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/translations/es-ES/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md @@ -192,7 +192,7 @@ For pull requests, you can also use search to: - Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat` - Filter pull requests by the specific user [requested for review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat`{% ifversion fpt or ghae or ghes > 3.2 or ghec %} - Filter pull requests that someone has asked you directly to review: `state:open type:pr user-review-requested:@me`{% endif %} -- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom` +- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/docs` - Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue` ## Sorting issues and pull requests diff --git a/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index e1c0cc329d..44bb21d747 100644 --- a/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -62,11 +62,11 @@ For more information on Punycodes, see [Internationalized domain name](https://e {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM. IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . + > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -104,19 +104,19 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. - For `A` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t A - > EXAMPLE.COM 3600 IN A 185.199.108.153 - > EXAMPLE.COM 3600 IN A 185.199.109.153 - > EXAMPLE.COM 3600 IN A 185.199.110.153 - > EXAMPLE.COM 3600 IN A 185.199.111.153 + $ dig EXAMPLE.COM +noall +answer -t A + > EXAMPLE.COM 3600 IN A 185.199.108.153 + > EXAMPLE.COM 3600 IN A 185.199.109.153 + > EXAMPLE.COM 3600 IN A 185.199.110.153 + > EXAMPLE.COM 3600 IN A 185.199.111.153 ``` - For `AAAA` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t AAAA - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 + $ dig EXAMPLE.COM +noall +answer -t AAAA + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -132,11 +132,11 @@ After you configure the apex domain, you must configure a CNAME record with your 1. Navigate to your DNS provider and create a `CNAME` record that points `www.example.com` to the default domain for your site: `.github.io` or `.github.io`. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} 2. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER. + > GITHUB-PAGES-SERVER. 22 IN A 192.0.2.1 ``` ## Removing a custom domain diff --git a/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index 437739a13a..a53dcfa122 100644 --- a/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -1,6 +1,6 @@ --- -title: Resolver un conflicto de fusión con la línea de comando -intro: Puedes resolver conflictos de fusión con la línea de comando y un editor de texto. +title: Resolving a merge conflict using the command line +intro: You can resolve merge conflicts using the command line and a text editor. redirect_from: - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line - /articles/resolving-a-merge-conflict-from-the-command-line @@ -15,33 +15,27 @@ versions: topics: - Pull requests shortTitle: Resolve merge conflicts in Git -ms.openlocfilehash: 1d4ff97c2a93d3e5a7aebaa8752810e284203bc1 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/11/2022 -ms.locfileid: '147883461' --- -Los conflictos de fusión ocurren cuando se hacen cambios contrapuestos en la misma línea de un archivo o cuando una persona edita un archivo y otra persona borra el mismo archivo. Para más información, vea "[Acerca de los conflictos de combinación](/articles/about-merge-conflicts/)". +Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)." {% tip %} -**Sugerencia:** Puede usar el editor de conflictos de {% data variables.product.product_name %} para resolver conflictos de combinación de cambios de líneas contrapuestos entre ramas que forman parte de una solicitud de incorporación de cambios. Para más información, vea "[Resolución de un conflicto de combinación en GitHub](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)". +**Tip:** You can use the conflict editor on {% data variables.product.product_name %} to resolve competing line change merge conflicts between branches that are part of a pull request. For more information, see "[Resolving a merge conflict on GitHub](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." {% endtip %} -## Conflictos de fusión de cambios de líneas contrapuestos +## Competing line change merge conflicts -Para resolver un conflicto de fusión causado por cambios de líneas contrapuestos, debes decidir qué cambios incorporar desde las diferentes ramas de una confirmación nueva. +To resolve a merge conflict caused by competing line changes, you must choose which changes to incorporate from the different branches in a new commit. -Por ejemplo, si usted y otra persona han editado el archivo _styleguide.md_ en las mismas líneas de diferentes ramas del mismo repositorio de Git, recibirá un error de conflicto de combinación cuando intente combinar estas ramas. Debes resolver este conflicto de fusión con una confirmación nueva antes de que puedas fusionar estas ramas. +For example, if you and another person both edited the file _styleguide.md_ on the same lines in different branches of the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navega en el repositorio de Git local que tiene el conflicto de fusión. +2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` -3. Genera una lista de los archivos afectados por el conflicto de fusión. En este ejemplo, el archivo *styleguide.md* tiene un conflicto de combinación. +3. Generate a list of the files affected by the merge conflict. In this example, the file *styleguide.md* has a merge conflict. ```shell $ git status > # On branch branch-b @@ -55,8 +49,8 @@ Por ejemplo, si usted y otra persona han editado el archivo _styleguide.md_ en l > # > no changes added to commit (use "git add" and/or "git commit -a") ``` -4. Abra el editor de texto que prefiera, por ejemplo [Atom](https://atom.io/), y vaya al archivo que tiene conflictos de combinación. -5. Para ver el origen de un conflicto de combinación en el archivo, busque el marcador de conflicto `<<<<<<<` en el archivo. Al abrir el archivo en el editor de texto, verá los cambios de la rama HEAD o de base después de la línea `<<<<<<< HEAD`. A continuación, verá `=======`, que divide los cambios de los de la otra rama, seguido de `>>>>>>> BRANCH-NAME`. En este ejemplo, una persona ha escrito "abrir una incidencia" en la rama HEAD o de base, y otra persona ha escrito "formula tu pregunta en IRC" en la rama comparada o `branch-a`. +4. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. +5. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`. ``` If you have questions, please @@ -66,34 +60,34 @@ Por ejemplo, si usted y otra persona han editado el archivo _styleguide.md_ en l ask your question in IRC. >>>>>>> branch-a ``` -{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %}En este ejemplo, ambos cambios se incorporaron en la fusión final: +{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} In this example, both changes are incorporated into the final merge: ```shell If you have questions, please open an issue or ask in our IRC channel if it's more urgent. ``` -7. Agrega o lanza tus cambios. +7. Add or stage your changes. ```shell $ git add . ``` -8. Confirma tus cambios con un comentario. +8. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by incorporating both suggestions." ``` -Ahora puede combinar las ramas en la línea de comandos, o bien [insertar los cambios en el repositorio remoto](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) en {% data variables.product.product_name %} y [combinar los cambios](/articles/merging-a-pull-request/) en una solicitud de incorporación de cambios. +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## Conflictos de fusión de archivos eliminados +## Removed file merge conflicts -Para resolver un conflicto de fusión causado por cambios contrapuestos en un archivo, cuando una persona elimina un archivo en una rama y otra persona edita el mismo archivo, debes decidir si eliminar o conservar el archivo eliminado en una confirmación nueva. +To resolve a merge conflict caused by competing changes to a file, where a person deletes a file in one branch and another person edits the same file, you must choose whether to delete or keep the removed file in a new commit. -Por ejemplo, si ha editado un archivo, como *README.md*, y otra persona ha eliminado el mismo archivo en otra rama del mismo repositorio de Git, recibirá un error de conflicto de combinación cuando intente combinar estas ramas. Debes resolver este conflicto de fusión con una confirmación nueva antes de que puedas fusionar estas ramas. +For example, if you edited a file, such as *README.md*, and another person removed the same file in another branch in the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navega en el repositorio de Git local que tiene el conflicto de fusión. +2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` -2. Genera una lista de los archivos afectados por el conflicto de fusión. En este ejemplo, el archivo *README.md* tiene un conflicto de combinación. +2. Generate a list of the files affected by the merge conflict. In this example, the file *README.md* has a merge conflict. ```shell $ git status > # On branch main @@ -106,32 +100,32 @@ Por ejemplo, si ha editado un archivo, como *README.md*, y otra persona ha elimi > # Unmerged paths: > # (use "git add/rm ..." as appropriate to mark resolution) > # - > # deleted by us: README.md + > # deleted by us: README.md > # > # no changes added to commit (use "git add" and/or "git commit -a") ``` -3. Abra el editor de texto que prefiera, por ejemplo [Atom](https://atom.io/), y vaya al archivo que tiene conflictos de combinación. -6. Decide si quieres conservar el archivo eliminado. Puede que quieras ver los últimos cambios hechos en el archivo eliminado en tu editor de texto. +3. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. +6. Decide if you want keep the removed file. You may want to view the latest changes made to the removed file in your text editor. - Para volver a agregar el archivo eliminado a tu repositorio: + To add the removed file back to your repository: ```shell $ git add README.md ``` - Para eliminar este archivo de tu repositorio: + To remove this file from your repository: ```shell $ git rm README.md > README.md: needs merge > rm 'README.md' ``` -7. Confirma tus cambios con un comentario. +7. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by keeping README.md file." > [branch-d 6f89e49] Merge branch 'branch-c' into branch-d ``` -Ahora puede combinar las ramas en la línea de comandos, o bien [insertar los cambios en el repositorio remoto](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) en {% data variables.product.product_name %} y [combinar los cambios](/articles/merging-a-pull-request/) en una solicitud de incorporación de cambios. +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## Información adicional +## Further reading -- "[Acerca de los conflictos de combinación](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" -- "[Extracción del repositorio de las solicitudes de incorporación de cambios localmente](/articles/checking-out-pull-requests-locally/)" +- "[About merge conflicts](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" +- "[Checking out pull requests locally](/articles/checking-out-pull-requests-locally/)" diff --git a/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md b/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md index ca86371e9b..a137dad617 100644 --- a/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md +++ b/translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md @@ -83,7 +83,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u To merge a pull request, use the `gh pr merge` subcommand. Replace `pull-request` with the number, URL, or head branch of the pull request. ```shell -gh pr merge pull-request +gh pr merge PULL-REQUEST ``` Follow the interactive prompts to complete the merge. For more information about the merge methods that you can choose, see "[About pull request merges](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." diff --git a/translations/es-ES/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md b/translations/es-ES/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index 75f9b96723..2805786381 100644 --- a/translations/es-ES/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/translations/es-ES/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -90,7 +90,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da 1. To create a release, use the `gh release create` subcommand. Replace `tag` with the desired tag for the release. ```shell - gh release create tag + gh release create TAG ``` 2. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_release_create). For example, this command creates a prerelease with the specified title and notes. @@ -153,7 +153,7 @@ Releases cannot currently be edited with {% data variables.product.prodname_cli 1. To delete a release, use the `gh release delete` subcommand. Replace `tag` with the tag of the release to delete. Use the `-y` flag to skip confirmation. ```shell - gh release delete tag -y + gh release delete TAG -y ``` {% endcli %} diff --git a/translations/es-ES/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/translations/es-ES/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md index a4319acbc0..358b0e8a2b 100644 --- a/translations/es-ES/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md +++ b/translations/es-ES/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -1,6 +1,6 @@ --- -title: Acerca de los archivos grandes en GitHub -intro: '{% data variables.product.product_name %} limita el tamaño de los archivos que puedes rastrear en los repositorios regulares de Git. Aprende cómo rastrear o eliminar archivos que sobrepasan el límite.' +title: About large files on GitHub +intro: '{% data variables.product.product_name %} limits the size of files you can track in regular Git repositories. Learn how to track or remove files that are beyond the limit.' redirect_from: - /articles/distributing-large-binaries - /github/managing-large-files/distributing-large-binaries @@ -22,88 +22,85 @@ versions: ghae: '*' ghec: '*' shortTitle: Large files -ms.openlocfilehash: c9910f669b13c0c2bc4a8517ac6b33476b23b475 -ms.sourcegitcommit: 80842b4e4c500daa051eff0ccd7cde91c2d4bb36 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/12/2022 -ms.locfileid: '146331652' --- -## Acerca de los límites de tamaño en {% data variables.product.product_name %} -{% ifversion fpt or ghec %} {% data variables.product.product_name %} intenta proporcionar un abundante almacenamiento para todos los repositorios de Git, pero hay límites muy estrictos de tamaños de archivos y repositorios. Para garantizar el rendimiento y la legibilidad para nuestros usuarios, monitoreamos activamente las señales de la salud general de los repositorios. La salud de los repositorios es una función de varios factores de interacción, incluyendo el tamaño, frecuencia de confirmaciones y estructura. +## About size limits on {% data variables.product.product_name %} -### Límites de tamaño de archivo +{% ifversion fpt or ghec %} +{% data variables.product.product_name %} tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes. To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health is a function of various interacting factors, including size, commit frequency, contents, and structure. + +### File size limits {% endif %} -{% data variables.product.product_name %} limita el tamaño de los archivos permitidos en los repositorios. Recibirás una advertencia de Git si intentas añadir o actualizar un archivo mayor a {% data variables.large_files.warning_size %}. Los cambios aún se subirán a tu repositorio, pero puedes considerar eliminar la confirmación para minimizar el impacto en el rendimiento. Para obtener más información, consulte "[Eliminación de archivos del historial de un repositorio](#removing-files-from-a-repositorys-history)". +{% data variables.product.product_name %} limits the size of files allowed in repositories. If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](#removing-files-from-a-repositorys-history)." {% note %} -**Nota:** Si agrega un archivo a un repositorio por medio de un explorador, el archivo no puede ser mayor de {% data variables.large_files.max_github_browser_size %}. Para obtener más información, consulte "[Adición de un archivo a un repositorio](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)". +**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." {% endnote %} -{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} bloquea los envíos de cambios que superan los {% data variables.large_files.max_github_size %}. {% ifversion ghes %}Sin embargo, el administrador de un sitio puede configurar un límite diferente para {% data variables.product.product_location %}. Para obtener más información, consulte "[Configuración de límites de envío de cambios en Git](/enterprise/admin/guides/installation/setting-git-push-limits)".{% endif %} +{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks files larger than {% data variables.large_files.max_github_size %}. {% ifversion ghes %}However, a site administrator can configure a different limit for {% data variables.product.product_location %}. For more information, see "[Setting Git push limits](/enterprise/admin/guides/installation/setting-git-push-limits)."{% endif %} -Para rastrear archivos que sobrepasen este límite, debes utilizar {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}). Para obtener más información, consulte "[Acerca de {% data variables.large_files.product_name_long %}](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)". +To track files beyond this limit, you must use {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}). For more information, see "[About {% data variables.large_files.product_name_long %}](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)." -Si necesitas distribuir archivos grandes dentro de tu repositorio, puedes crear lanzamientos en {% data variables.product.product_location %} en vez de rastrear los archivos. Para obtener más información, consulte "[Distribución de archivos binarios grandes](#distributing-large-binaries)". +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %} instead of tracking the files. For more information, see "[Distributing large binaries](#distributing-large-binaries)." -Git no se diseñó para manejar archivos grandes de SQL. Para compartir bases de datos grandes con otros desarrolladores, se recomienda usar [Dropbox](https://www.dropbox.com/). +Git is not designed to handle large SQL files. To share large databases with other developers, we recommend using [Dropbox](https://www.dropbox.com/). -{% ifversion fpt or ghec %} -### Límites de tamaño de repositorio +{% ifversion fpt or ghec or ghae %} +### Repository size limits -Te recomendamos que los repositorios sean siempre pequeños, idealmente, de menos de 1 GB, y se recomienda ampliamente que sean de menos de 5GB. Los repositorios más pequeños se clonan más rápido y se puede mantenerlos mejor y trabajar en ellos más fácilmente. Si tu repositorio impacta excesivamente nuestra infraestructura, puede que recibas un mensaje de correo electrónico de {% data variables.contact.github_support %}, el cual te solicitará que tomes acciones correctivas. Intentamos ser flexibles, especialmente con proyectos grandes que tienen muchos colaboradores, y trabajaremos junto contigo para encontrar una resolución cada que sea posible. Puedes prevenir que tu repositorio impacte nuestra infraestructura si administras el tamaño de tu repositorio y su salud general con eficacia. Puede encontrar consejos y una herramienta para el análisis de repositorios en el repositorio [`github/git-sizer`](https://github.com/github/git-sizer). +We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. {% ifversion ghae %}The maximum size for a repository on {% data variables.product.product_name %} is 100 GB. {% endif %}Smaller repositories are faster to clone and easier to work with and maintain. If your repository excessively impacts our infrastructure, you might receive an email from {% data variables.contact.github_support %} asking you to take corrective action. We try to be flexible, especially with large projects that have many collaborators, and will work with you to find a resolution whenever possible. You can prevent your repository from impacting our infrastructure by effectively managing your repository's size and overall health. You can find advice and a tool for repository analysis in the [`github/git-sizer`](https://github.com/github/git-sizer) repository. -Las dependencias externas pueden causar que los repositorios de Git se hagan muy grandes. Para evitar llenar un repositorio con dependencias externas, te recomendamos utilizar un administrador de paquetes. Entre los administradores de paquetes más populares para los lenguajes comunes se incluyen [Bundler](http://bundler.io/), el [Administrador de paquetes de Node](http://npmjs.org/) y [Maven](http://maven.apache.org/). Estos administradores de paquetes soportan la utilización directa de repositorios de Git para que no dependas de fuentes pre-empacadas. +External dependencies can cause Git repositories to become very large. To avoid filling a repository with external dependencies, we recommend you use a package manager. Popular package managers for common languages include [Bundler](http://bundler.io/), [Node's Package Manager](http://npmjs.org/), and [Maven](http://maven.apache.org/). These package managers support using Git repositories directly, so you don't need pre-packaged sources. -Git no está diseñado para fungir como una herramienta de respaldo. Sin embargo, hay muchas soluciones diseñadas específicamente para realizar copias de seguridad, como [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/) y [CrashPlan](https://www.crashplan.com/en-us/). +Git is not designed to serve as a backup tool. However, there are many solutions specifically designed for performing backups, such as [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/), and [CrashPlan](https://www.crashplan.com/en-us/). {% endif %} -## Eliminar archivos del historial de un repositorio +## Removing files from a repository's history {% warning %} -**Advertencia**: Estos procedimientos eliminarán archivos de manera permanente del repositorio de su equipo y de {% data variables.product.product_location %}. Si el archivo es importante, haz una copia de seguridad local en un directorio por fuera del repositorio. +**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.product.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. {% endwarning %} -### Eliminar un archivo agregado en la confirmación más reciente no subida +### Removing a file added in the most recent unpushed commit -Si el archivo se agregó con tu confirmación más reciente, y no lo subiste a {% data variables.product.product_location %}, puedes eliminar el archivo y modificar la confirmación: +If the file was added with your most recent commit, and you have not pushed to {% data variables.product.product_location %}, you can delete the file and amend the commit: -{% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.switching_directories_procedural %} -3. Para quitar el archivo, escriba `git rm --cached`: +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +3. To remove the file, enter `git rm --cached`: ```shell - $ git rm --cached giant_file + $ git rm --cached GIANT_FILE # Stage our giant file for removal, but leave it on disk ``` -4. Confirme este cambio con `--amend -CHEAD`: +4. Commit this change using `--amend -CHEAD`: ```shell $ git commit --amend -CHEAD # Amend the previous commit with your change # Simply making a new commit won't work, as you need # to remove the file from the unpushed history as well ``` -5. Sube tus confirmaciones a {% data variables.product.product_location %}: +5. Push your commits to {% data variables.product.product_location %}: ```shell $ git push # Push our rewritten, smaller commit ``` -### Eliminar un archivo que se añadió en una confirmación de cambios previa +### Removing a file that was added in an earlier commit -Si añadiste un archivo en una confirmación previa, necesitas eliminarlo del historial del repositorio. Para quitar archivos del historial del repositorio, puede usar BFG Repo-Cleaner o el comando `git filter-branch`. Para obtener más información, consulte "[Eliminación de datos confidenciales de un repositorio](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)". +If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." -## Distribuir binarios grandes +## Distributing large binaries -Si necesitas distribuir archivos grandes dentro de tu repositorio, puedes crear lanzamientos en {% data variables.product.product_location %}. Los lanzamientos te permiten empaquetar el software, notas de lanzamiento y enlaces a los archivos binarios para que otras personas puedan utilizarlos. Para obtener más información, consulte "[Acerca de las versiones](/github/administering-a-repository/about-releases)". +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %}. Releases allow you to package software, release notes, and links to binary files, for other people to use. For more information, visit "[About releases](/github/administering-a-repository/about-releases)." {% ifversion fpt or ghec %} -No limitamos el tamaño total de los archivos binarios en los lanzamientos o anchos de banda que se utilizan para entregarlos. Sin embargo, cada archivo individual debe ser menor a {% data variables.large_files.max_lfs_size %}. +We don't limit the total size of the binary files in the release or the bandwidth used to deliver them. However, each individual file must be smaller than {% data variables.large_files.max_lfs_size %}. {% endif %} diff --git a/translations/es-ES/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/translations/es-ES/content/repositories/working-with-files/using-files/working-with-non-code-files.md index 2621f90997..229230ac98 100644 --- a/translations/es-ES/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/translations/es-ES/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -340,7 +340,7 @@ To view a fully interactive version of your Jupyter Notebook, you can set up a n If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): ```shell -$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb +$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb ``` ### Further reading diff --git a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md index 083950084d..a744b76793 100644 --- a/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md @@ -163,7 +163,7 @@ With cURL, you will send an `Authorization` header with your token. Replace `YOU ```shell curl --request GET \ --url "https://api.github.com/octocat" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% note %} @@ -326,7 +326,7 @@ To send a header with cURL, use the `--header` or `-H` flag followed by the head curl --request GET \ --url "https://api.github.com/octocat" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -390,7 +390,7 @@ To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -443,7 +443,7 @@ For cURL, add a `?` to the end of the path, then append your query parameter nam curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -495,7 +495,7 @@ For cURL, use the `--data` flag to pass the body parameters in a JSON object. curl --request POST \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --data '{ "title": "Created with the REST API", "body": "This is a test issue created by the REST API" @@ -593,7 +593,7 @@ For example, this request: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --include ``` @@ -661,7 +661,7 @@ await octokit.request("GET /repos/{owner}/{repo}/issues", { curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -730,7 +730,7 @@ For example, you can use `>` to redirect the response to a file: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" > data.json +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` Then you can use jq to get the title and author ID of each issue: diff --git a/translations/es-ES/content/rest/overview/permissions-required-for-github-apps.md b/translations/es-ES/content/rest/overview/permissions-required-for-github-apps.md index ffa76e3719..a369469433 100644 --- a/translations/es-ES/content/rest/overview/permissions-required-for-github-apps.md +++ b/translations/es-ES/content/rest/overview/permissions-required-for-github-apps.md @@ -19,11 +19,12 @@ shortTitle: GitHub App permissions {% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[Setting permissions for GitHub Apps](/apps/building-github-apps/setting-permissions-for-github-apps/)." -## Metadata permissions + +## Metadata -GitHub Apps have the `Read-only` metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. +GitHub Apps have the **Read-only** metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. -{% data reusables.apps.metadata-permissions %} +If you set the metadata permission to **No access** and select a permission that requires repository access, GitHub will override your selection and set the metadata permission back to **Read-only**. To set the metadata permission to **No access**, you must set all permissions that require repository access to **No access** first. - [`GET /`](/rest#root-endpoint) - [`GET /codes_of_conduct`](/rest/reference/codes-of-conduct#get-all-codes-of-conduct) @@ -96,9 +97,6 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe - [`GET /gitignore/templates`](/rest/reference/gitignore#get-all-gitignore-templates) - [`GET /gitignore/templates/:key`](/rest/reference/gitignore#get-a-gitignore-template) -### Keys -- [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) - ### Organization members - [`GET /orgs/:org/members`](/rest/reference/orgs#list-organization-members) - [`GET /orgs/:org/members/:username`](/rest/reference/orgs#check-organization-membership-for-a-user) @@ -114,856 +112,903 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe - [`GET /search/topics`](/rest/reference/search#search-topics) - [`GET /search/users`](/rest/reference/search#search-users) -{% ifversion fpt or ghes or ghec %} -## Permission on "actions" +### SSH keys +- [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) -- [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) -- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (:write) -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (:read) +{% ifversion fpt or ghes or ghec %} + +## Actions + +- [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (read) +- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (write) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (read) {% ifversion actions-cache-management -%} -- [`GET /repos/:owner/:repo/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-a-repository) (read) {% endif -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (read) {% ifversion fpt or ghec -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/approve`](/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/approve`](/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request) (write) {% endif -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (:read) -- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (:write) -- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (:read) -- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (:write) -- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (:write) -- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (:read) -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (:read) -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (read) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (write) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (read) +- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (write) +- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (read) {% endif %} -## Permission on "administration" + +## Administration -- [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (:write) -- [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write) -- [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (:write) -- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write) -- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (:write) -- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (:write) +- [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (write) +- [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (write) +- [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (write) +- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (read) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (write) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (read) +- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (write) +- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (write) {% ifversion fpt or ghec or ghes -%} -- [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write) -- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write) +- [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (write) +- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (:write) +- [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#disable-automated-security-fixes) (:write) +- [`DELETE /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#disable-automated-security-fixes) (write) {% endif -%} -- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (:write) +- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (write) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) (:write) +- [`PUT /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (:write) +- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (write) {% endif -%} {% ifversion ghes > 3.3 -%} -- [`GET /repos/:owner/:repo/replicas/caches`](/rest/reference/repos#list-repository-cache-replication-status) (:read) +- [`GET /repos/:owner/:repo/replicas/caches`](/rest/reference/repos#list-repository-cache-replication-status) (read) {% endif -%} -- [`PUT /repos/:owner/:repo/topics`](/rest/reference/repos#replace-all-repository-topics) (:write) -- [`POST /repos/:owner/:repo/transfer`](/rest/reference/repos#transfer-a-repository) (:write) +- [`PUT /repos/:owner/:repo/topics`](/rest/reference/repos#replace-all-repository-topics) (write) +- [`POST /repos/:owner/:repo/transfer`](/rest/reference/repos#transfer-a-repository) (write) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (:read) +- [`GET /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (:write) +- [`PUT /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#disable-vulnerability-alerts) (:write) +- [`DELETE /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#disable-vulnerability-alerts) (write) {% endif -%} -- [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#accept-a-repository-invitation) (:write) -- [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#decline-a-repository-invitation) (:write) +- [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#accept-a-repository-invitation) (write) +- [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#decline-a-repository-invitation) (write) ### Branches -- [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#get-branch-protection) (:read) -- [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#update-branch-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#delete-branch-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#get-admin-branch-protection) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#set-admin-branch-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#delete-admin-branch-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#get-pull-request-review-protection) (:read) -- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#update-pull-request-review-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#delete-pull-request-review-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#get-commit-signature-protection) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#create-commit-signature-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#delete-commit-signature-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#get-status-checks-protection) (:read) -- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#update-status-check-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#remove-status-check-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#get-all-status-check-contexts) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#add-status-check-contexts) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#set-status-check-contexts) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#remove-status-check-contexts) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#get-access-restrictions) (:read) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#delete-access-restrictions) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#add-team-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#set-team-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#remove-team-access-restrictions) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/repos#list-users-with-access-to-the-protected-branch) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#add-user-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#set-user-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#remove-user-access-restrictions) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (:write) +- [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#get-branch-protection) (read) +- [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#update-branch-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#delete-branch-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#get-admin-branch-protection) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#set-admin-branch-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#delete-admin-branch-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#get-pull-request-review-protection) (read) +- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#update-pull-request-review-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#delete-pull-request-review-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#get-commit-signature-protection) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#create-commit-signature-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#delete-commit-signature-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#get-status-checks-protection) (read) +- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#update-status-check-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#remove-status-check-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#get-all-status-check-contexts) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#add-status-check-contexts) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#set-status-check-contexts) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#remove-status-check-contexts) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#get-access-restrictions) (read) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#delete-access-restrictions) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#add-team-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#set-team-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#remove-team-access-restrictions) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/repos#list-users-with-access-to-the-protected-branch) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#add-user-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#set-user-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#remove-user-access-restrictions) (write) +- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (write) ### Collaborators -- [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#add-a-repository-collaborator) (:write) -- [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#remove-a-repository-collaborator) (:write) +- [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#add-a-repository-collaborator) (write) +- [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#remove-a-repository-collaborator) (write) ### Invitations -- [`GET /repos/:owner/:repo/invitations`](/rest/reference/collaborators#list-repository-invitations) (:read) -- [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#update-a-repository-invitation) (:write) -- [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#delete-a-repository-invitation) (:write) +- [`GET /repos/:owner/:repo/invitations`](/rest/reference/collaborators#list-repository-invitations) (read) +- [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#update-a-repository-invitation) (write) +- [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#delete-a-repository-invitation) (write) -### Keys -- [`GET /repos/:owner/:repo/keys`](/rest/reference/deployments#list-deploy-keys) (:read) -- [`POST /repos/:owner/:repo/keys`](/rest/reference/deployments#create-a-deploy-key) (:write) -- [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#get-a-deploy-key) (:read) -- [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#delete-a-deploy-key) (:write) +### SSH keys +- [`GET /repos/:owner/:repo/keys`](/rest/reference/deployments#list-deploy-keys) (read) +- [`POST /repos/:owner/:repo/keys`](/rest/reference/deployments#create-a-deploy-key) (write) +- [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#get-a-deploy-key) (read) +- [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#delete-a-deploy-key) (write) ### Teams -- [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (:read) -- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:write) -- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) +- [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (read) +- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (write) +- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (write) {% ifversion fpt or ghec %} ### Traffic -- [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repository-metrics#get-repository-clones) (:read) -- [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repository-metrics#get-top-referral-paths) (:read) -- [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repository-metrics#get-top-referral-sources) (:read) -- [`GET /repos/:owner/:repo/traffic/views`](/rest/reference/repository-metrics#get-page-views) (:read) +- [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repository-metrics#get-repository-clones) (read) +- [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repository-metrics#get-top-referral-paths) (read) +- [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repository-metrics#get-top-referral-sources) (read) +- [`GET /repos/:owner/:repo/traffic/views`](/rest/reference/repository-metrics#get-page-views) (read) {% endif %} {% ifversion fpt or ghec %} -## Permission on "blocking" + +## Blocking users -- [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (:read) -- [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (:read) -- [`PUT /user/blocks/:username`](/rest/reference/users#block-a-user) (:write) -- [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (:write) +- [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (read) +- [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (read) +- [`PUT /user/blocks/:username`](/rest/reference/users#block-a-user) (write) +- [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (write) {% endif %} -## Permission on "checks" + +## Checks -- [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (:write) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) -- [`PATCH /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#update-a-check-run) (:write) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (:read) -- [`POST /repos/:owner/:repo/check-suites`](/rest/reference/checks#create-a-check-suite) (:write) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (:read) -- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (:write) -- [`PATCH /repos/:owner/:repo/check-suites/preferences`](/rest/reference/checks#update-repository-preferences-for-check-suites) (:write) -- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) +- [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (read) +- [`PATCH /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#update-a-check-run) (write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (read) +- [`POST /repos/:owner/:repo/check-suites`](/rest/reference/checks#create-a-check-suite) (write) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (read) +- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (write) +- [`PATCH /repos/:owner/:repo/check-suites/preferences`](/rest/reference/checks#update-repository-preferences-for-check-suites) (write) +- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (read) + + +## Code scanning alerts + +- [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (read) +- [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (write) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (read) +{% endif -%} +- [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (read) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (read) +{% endif -%} +{% ifversion fpt or ghec or ghes -%} +- [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (write) +{% endif -%} +- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (write) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (read) +{% endif -%} +{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 -%} +- [`GET /orgs/:org/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-by-organization) (read) +{% endif -%} {% ifversion fpt or ghec %} -## Permission on "codespaces" + +## Codespaces - [`GET /repos/:owner/:repo/codespaces/machines`](/rest/reference/codespaces#list-available-machine-types-for-a-repository) {% endif %} -## Permission on "contents" -- [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (:read) + +## Commit statuses + +- [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) (read) +- [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/commits#list-commit-statuses-for-a-reference) (read) +- [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/commits#create-a-commit-status) (write) + + +## Contents + +- [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (read) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (:write) +- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (:read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (read) {% endif -%} {% ifversion fpt -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (:write) +- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (write) {% endif -%} {% ifversion fpt -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:write) +- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#get-a-repository-secret) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#get-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#create-or-update-a-repository-secret) (:write) +- [`PUT /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#create-or-update-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#delete-a-repository-secret) (:write) +- [`DELETE /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#delete-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (:read) +- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (:read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (read) {% endif -%} -- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (:read) -- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (:write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (read) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (read) +- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (write) {% ifversion codeowners-errors %} -- [`GET /repos/:owner/:repo/codeowners/errors`](/rest/reference/repos#list-codeowners-errors) (:read) +- [`GET /repos/:owner/:repo/codeowners/errors`](/rest/reference/repos#list-codeowners-errors) (read) {% endif %} -- [`GET /repos/:owner/:repo/commits`](/rest/reference/commits#list-commits) (:read) -- [`GET /repos/:owner/:repo/commits/:sha`](/rest/reference/commits#get-a-commit) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/community/code_of_conduct`](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/compare/:base...:head`](/rest/reference/commits#compare-two-commits) (:read) -- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) -- [`POST /repos/:owner/:repo/dispatches`](/rest/reference/repos#create-a-repository-dispatch-event) (:write) -- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (:read) -- [`POST /repos/:owner/:repo/merges`](/rest/reference/branches#merge-a-branch) (:write) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (:read) +- [`GET /repos/:owner/:repo/commits`](/rest/reference/commits#list-commits) (read) +- [`GET /repos/:owner/:repo/commits/:sha`](/rest/reference/commits#get-a-commit) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/community/code_of_conduct`](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) (read) +- [`GET /repos/:owner/:repo/compare/:base...:head`](/rest/reference/commits#compare-two-commits) (read) +- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (read) +- [`POST /repos/:owner/:repo/dispatches`](/rest/reference/repos#create-a-repository-dispatch-event) (write) +- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (read) +- [`POST /repos/:owner/:repo/merges`](/rest/reference/branches#merge-a-branch) (write) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (write) +- [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (read) ### Branches -- [`GET /repos/:owner/:repo/branches`](/rest/reference/branches#list-branches) (:read) -- [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/branches#get-a-branch) (:read) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#add-app-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#set-app-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#remove-user-access-restrictions) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (:write) +- [`GET /repos/:owner/:repo/branches`](/rest/reference/branches#list-branches) (read) +- [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/branches#get-a-branch) (read) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (write) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#add-app-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#set-app-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#remove-user-access-restrictions) (write) +- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (write) ### Commit comments -- [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#update-a-commit-comment) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#delete-a-commit-comment) (:write) -- [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (:write) -- [`POST /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/commits#create-a-commit-comment) (:write) +- [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#update-a-commit-comment) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#delete-a-commit-comment) (write) +- [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (write) +- [`POST /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/commits#create-a-commit-comment) (write) ### Git -- [`POST /repos/:owner/:repo/git/blobs`](/rest/reference/git#create-a-blob) (:write) -- [`GET /repos/:owner/:repo/git/blobs/:sha`](/rest/reference/git#get-a-blob) (:read) -- [`POST /repos/:owner/:repo/git/commits`](/rest/reference/git#create-a-commit) (:write) -- [`GET /repos/:owner/:repo/git/commits/:commit_id`](/rest/reference/git#get-a-commit) (:read) -- [`POST /repos/:owner/:repo/git/refs`](/rest/reference/git#create-a-reference) (:write) -- [`GET /repos/:owner/:repo/git/ref/:ref`](/rest/reference/git#get-a-reference) (:read) -- [`GET /repos/:owner/:repo/git/matching-refs/:ref`](/rest/reference/git#list-matching-references) (:read) -- [`PATCH /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#update-a-reference) (:write) -- [`DELETE /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#delete-a-reference) (:write) -- [`POST /repos/:owner/:repo/git/tags`](/rest/reference/git#create-a-tag-object) (:write) -- [`GET /repos/:owner/:repo/git/tags/:tag_id`](/rest/reference/git#get-a-tag) (:read) -- [`POST /repos/:owner/:repo/git/trees`](/rest/reference/git#create-a-tree) (:write) -- [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (:read) +- [`POST /repos/:owner/:repo/git/blobs`](/rest/reference/git#create-a-blob) (write) +- [`GET /repos/:owner/:repo/git/blobs/:sha`](/rest/reference/git#get-a-blob) (read) +- [`POST /repos/:owner/:repo/git/commits`](/rest/reference/git#create-a-commit) (write) +- [`GET /repos/:owner/:repo/git/commits/:commit_id`](/rest/reference/git#get-a-commit) (read) +- [`POST /repos/:owner/:repo/git/refs`](/rest/reference/git#create-a-reference) (write) +- [`GET /repos/:owner/:repo/git/ref/:ref`](/rest/reference/git#get-a-reference) (read) +- [`GET /repos/:owner/:repo/git/matching-refs/:ref`](/rest/reference/git#list-matching-references) (read) +- [`PATCH /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#update-a-reference) (write) +- [`DELETE /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#delete-a-reference) (write) +- [`POST /repos/:owner/:repo/git/tags`](/rest/reference/git#create-a-tag-object) (write) +- [`GET /repos/:owner/:repo/git/tags/:tag_id`](/rest/reference/git#get-a-tag) (read) +- [`POST /repos/:owner/:repo/git/trees`](/rest/reference/git#create-a-tree) (write) +- [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (read) {% ifversion fpt or ghec %} ### Import -- [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (:read) -- [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (:write) -- [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (:write) -- [`DELETE /repos/:owner/:repo/import`](/rest/reference/migrations#cancel-an-import) (:write) -- [`GET /repos/:owner/:repo/import/authors`](/rest/reference/migrations#get-commit-authors) (:read) -- [`PATCH /repos/:owner/:repo/import/authors/:author_id`](/rest/reference/migrations#map-a-commit-author) (:write) -- [`GET /repos/:owner/:repo/import/large_files`](/rest/reference/migrations#get-large-files) (:read) -- [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (:write) +- [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (read) +- [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (write) +- [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (write) +- [`DELETE /repos/:owner/:repo/import`](/rest/reference/migrations#cancel-an-import) (write) +- [`GET /repos/:owner/:repo/import/authors`](/rest/reference/migrations#get-commit-authors) (read) +- [`PATCH /repos/:owner/:repo/import/authors/:author_id`](/rest/reference/migrations#map-a-commit-author) (write) +- [`GET /repos/:owner/:repo/import/large_files`](/rest/reference/migrations#get-large-files) (read) +- [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (write) {% endif %} ### Reactions - -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) ### Releases -- [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (:read) -- [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (:write) -- [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (:read) -- [`PATCH /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#update-a-release) (:write) -- [`DELETE /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#delete-a-release) (:write) -- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/rest/reference/repos/#list-release-assets) (:read) -- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#get-a-release-asset) (:read) -- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#update-a-release-asset) (:write) -- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#delete-a-release-asset) (:write) -- [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (:read) -- [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (:read) +- [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (read) +- [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (write) +- [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (read) +- [`PATCH /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#update-a-release) (write) +- [`DELETE /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#delete-a-release) (write) +- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/rest/reference/repos/#list-release-assets) (read) +- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#get-a-release-asset) (read) +- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#update-a-release-asset) (write) +- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#delete-a-release-asset) (write) +- [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (read) +- [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (read) -## Permission on "deployments" +{% ifversion dependabot-alerts-rest-api %} +## Dependabot alerts -- [`GET /repos/:owner/:repo/deployments`](/rest/reference/deployments#list-deployments) (:read) -- [`POST /repos/:owner/:repo/deployments`](/rest/reference/deployments#create-a-deployment) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#get-a-deployment) (:read) -- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#delete-a-deployment) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#list-deployment-statuses) (:read) -- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#create-a-deployment-status) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/deployments#get-a-deployment-status) (:read) +- [`GET /repos/:owner/:repo/dependabot/alerts`](/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/dependabot/alerts/:alert_number`](/rest/dependabot/alerts#get-a-dependabot-alert) (read) +- [`PATCH /repos/:owner/:repo/dependabot/alerts/:alert_number`](/rest/dependabot/alerts#update-a-dependabot-alert) (write) +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.3%} + +## Dependabot secrets + +- [`GET /repos/:owner/:repo/dependabot/secrets/public-key`](/rest/reference/dependabot#get-a-repository-public-key) (read) +- [`GET /repos/:owner/:repo/dependabot/secrets`](/rest/reference/dependabot#list-repository-secrets) (read) +- [`GET /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-a-repository-secret) (read) +- [`PUT /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-a-repository-secret) (write) +- [`DELETE /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-a-repository-secret) (write) +- [`GET /orgs/:org/dependabot/secrets/public-key`](/rest/reference/dependabot#get-an-organization-public-key) (read) +- [`GET /orgs/:org/dependabot/secrets`](/rest/reference/dependabot#list-organization-secrets) (read) +- [`GET /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-an-organization-secret) (read) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-an-organization-secret) (write) +- [`GET /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret) (read) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) (write) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#add-selected-repository-to-an-organization-secret) (write) +- [`DELETE /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) (write) +- [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (write) +{% endif %} + + +## Deployments + +- [`GET /repos/:owner/:repo/deployments`](/rest/reference/deployments#list-deployments) (read) +- [`POST /repos/:owner/:repo/deployments`](/rest/reference/deployments#create-a-deployment) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#get-a-deployment) (read) +- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#delete-a-deployment) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#list-deployment-statuses) (read) +- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#create-a-deployment-status) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/deployments#get-a-deployment-status) (read) {% ifversion fpt or ghes or ghec %} -## Permission on "emails" + +## Email addresses {% ifversion fpt or ghec -%} -- [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (:write) +- [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (write) {% endif -%} -- [`GET /user/emails`](/rest/reference/users#list-email-addresses-for-the-authenticated-user) (:read) -- [`POST /user/emails`](/rest/reference/users#add-an-email-address-for-the-authenticated-user) (:write) -- [`DELETE /user/emails`](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) (:write) -- [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (:read) +- [`GET /user/emails`](/rest/reference/users#list-email-addresses-for-the-authenticated-user) (read) +- [`POST /user/emails`](/rest/reference/users#add-an-email-address-for-the-authenticated-user) (write) +- [`DELETE /user/emails`](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) (write) +- [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (read) {% endif %} -## Permission on "followers" + +## Followers -- [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (:read) -- [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (:read) -- [`GET /user/following/:username`](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) (:read) -- [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (:write) -- [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (:write) +- [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (read) +- [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (read) +- [`GET /user/following/:username`](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) (read) +- [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (write) +- [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (write) -## Permission on "gpg keys" + +## Git SSH keys -- [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (:read) -- [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (:write) -- [`GET /user/gpg_keys/:gpg_key_id`](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) (:read) -- [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (:write) +- [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (read) +- [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (write) +- [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (read) +- [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (write) + + +## GPG keys + +- [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (read) +- [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (write) +- [`GET /user/gpg_keys/:gpg_key_id`](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) (read) +- [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (write) {% ifversion fpt or ghec %} -## Permission on "interaction limits" + +## Interaction limits -- [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (:read) -- [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (:write) -- [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (:write) +- [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (read) +- [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (write) +- [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (write) {% endif %} -## Permission on "issues" + +## Issues Issues and pull requests are closely related. For more information, see "[List issues assigned to the authenticated user](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues. -- [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (:read) -- [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#get-an-issue) (:read) -- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (:read) -- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (:read) -- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) +- [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (read) +- [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#get-an-issue) (read) +- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (read) +- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (read) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (read) +- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) ### Assignees -- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) -- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) +- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (read) +- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (write) ### Events -- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) -- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) +- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (read) +- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (read) ### Labels -- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (:write) -- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (:write) -- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (:read) -- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) -- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (write) +- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (read) +- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (write) +- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (read) +- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (write) +- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (write) ### Milestones -- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) -- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) -- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (:write) -- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) +- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (read) +- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (read) +- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (write) +- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (read) ### Reactions -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) -## Permission on "keys" - -### Keys -- [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (:read) -- [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (:write) -- [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (:read) -- [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (:write) - -## Permission on "members" + +## Members {% ifversion fpt or ghec -%} -- [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (:write) +- [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PATCH /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#create-or-update-idp-group-connections) (:write) +- [`PATCH /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#create-or-update-idp-group-connections) (write) {% endif -%} -- [`GET /orgs/:org/outside_collaborators`](/rest/reference/orgs#list-outside-collaborators-for-an-organization) (:read) -- [`PUT /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) (:write) -- [`DELETE /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) (:write) +- [`GET /orgs/:org/outside_collaborators`](/rest/reference/orgs#list-outside-collaborators-for-an-organization) (read) +- [`PUT /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) (write) +- [`DELETE /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) (write) {% ifversion fpt or ghec -%} -- [`GET /orgs/:org/team-sync/groups`](/rest/teams/team-sync#list-idp-groups-for-an-organization) (:write) +- [`GET /orgs/:org/team-sync/groups`](/rest/teams/team-sync#list-idp-groups-for-an-organization) (write) {% endif -%} -- [`GET /orgs/:org/team/:team_id`](/rest/teams/teams#get-a-team-by-name) (:read) +- [`GET /orgs/:org/team/:team_id`](/rest/teams/teams#get-a-team-by-name) (read) {% ifversion fpt or ghec -%} -- [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (:write) +- [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`POST /scim/v2/orgs/:org/Users`](/rest/reference/scim#provision-and-invite-a-scim-user) (:write) +- [`POST /scim/v2/orgs/:org/Users`](/rest/reference/scim#provision-and-invite-a-scim-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (:write) +- [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#set-scim-information-for-a-provisioned-user) (:write) +- [`PUT /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#set-scim-information-for-a-provisioned-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PATCH /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#update-an-attribute-for-a-scim-user) (:write) +- [`PATCH /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#update-an-attribute-for-a-scim-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#delete-a-scim-user-from-an-organization) (:write) +- [`DELETE /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#delete-a-scim-user-from-an-organization) (write) {% endif %} {% ifversion fpt or ghec %} ### Invitations -- [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (:read) -- [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (:write) -- [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (:read) -- [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (:read) +- [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (read) +- [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (write) +- [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (read) +- [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (read) {% endif %} ### Organization members -- [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (:write) -- [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (:read) -- [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (:write) -- [`DELETE /orgs/:org/memberships/:username`](/rest/reference/orgs#remove-organization-membership-for-a-user) (:write) -- [`PUT /orgs/:org/public_members/:username`](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) (:write) -- [`DELETE /orgs/:org/public_members/:username`](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) (:write) -- [`GET /user/memberships/orgs`](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) (:read) -- [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (:read) -- [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (:write) +- [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (write) +- [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (read) +- [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (write) +- [`DELETE /orgs/:org/memberships/:username`](/rest/reference/orgs#remove-organization-membership-for-a-user) (write) +- [`PUT /orgs/:org/public_members/:username`](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) (write) +- [`DELETE /orgs/:org/public_members/:username`](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) (write) +- [`GET /user/memberships/orgs`](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) (read) +- [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (read) +- [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (write) ### Team members -- [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (:read) -- [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (:read) -- [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (:write) -- [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (:write) +- [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (read) +- [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (read) +- [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (write) +- [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (write) ### Teams -- [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (:read) -- [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (:write) -- [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (:read) -- [`PATCH /teams/:team_id`](/rest/reference/teams#update-a-team) (:write) -- [`DELETE /teams/:team_id`](/rest/reference/teams#delete-a-team) (:write) -- [`GET /teams/:team_id/projects`](/rest/reference/teams#list-team-projects) (:read) -- [`GET /teams/:team_id/projects/:project_id`](/rest/reference/teams#check-team-permissions-for-a-project) (:read) -- [`PUT /teams/:team_id/projects/:project_id`](/rest/reference/teams#add-or-update-team-project-permissions) (:read) -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) -- [`GET /teams/:team_id/repos`](/rest/reference/teams#list-team-repositories) (:read) -- [`GET /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#check-team-permissions-for-a-repository) (:read) -- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:read) -- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) -- [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (:read) +- [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (read) +- [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (write) +- [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (read) +- [`PATCH /teams/:team_id`](/rest/reference/teams#update-a-team) (write) +- [`DELETE /teams/:team_id`](/rest/reference/teams#delete-a-team) (write) +- [`GET /teams/:team_id/projects`](/rest/reference/teams#list-team-projects) (read) +- [`GET /teams/:team_id/projects/:project_id`](/rest/reference/teams#check-team-permissions-for-a-project) (read) +- [`PUT /teams/:team_id/projects/:project_id`](/rest/reference/teams#add-or-update-team-project-permissions) (read) +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) +- [`GET /teams/:team_id/repos`](/rest/reference/teams#list-team-repositories) (read) +- [`GET /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#check-team-permissions-for-a-repository) (read) +- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (read) +- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (write) +- [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (read) -## Permission on "organization administration" + +## Organization administration -- [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (:write) +- [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (write) {% ifversion actions-cache-management -%} -- [`GET /orgs/:org/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-an-organization) (:read) -- [`GET /orgs/:org/actions/cache/usage-by-repository`](/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization) (:read) +- [`GET /orgs/:org/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-an-organization) (read) +- [`GET /orgs/:org/actions/cache/usage-by-repository`](/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /orgs/:org/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) (:read) +- [`GET /orgs/:org/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /orgs/:org/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) (:write) +- [`PUT /orgs/:org/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (:write) +- [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (write) {% endif %} -## Permission on "organization events" + +## Organization events -- [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (:read) - -## Permission on "organization hooks" - -- [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (:read) -- [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (:write) -- [`GET /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#get-an-organization-webhook) (:read) -- [`PATCH /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#update-an-organization-webhook) (:write) -- [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (:write) -- [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (:write) - -### Teams -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) +- [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (read) {% ifversion ghes %} -## Permission on "organization pre receive hooks" + +## Organization pre-receive hooks -- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read) -- [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (:read) -- [`PATCH /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) (:write) -- [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (:write) +- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (read) +- [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (read) +- [`PATCH /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) (write) +- [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (write) {% endif %} -## Permission on "organization projects" + +## Organization projects -- [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (:write) -- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) -- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) -- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (:write) -- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (:read) -- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (:write) -- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (:read) -- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (:write) -- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (:write) -- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (:read) -- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (:write) -- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (:read) -- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (:write) -- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (:write) -- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) +- [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (write) +- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (read) +- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (write) +- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (write) +- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (read) +- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (write) +- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (read) +- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (write) +- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (write) +- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (read) +- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (write) +- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (read) +- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (write) +- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (write) +- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (write) {% ifversion fpt or ghec %} -## Permission on "organization user blocking" + +## Organization user blocking -- [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (:read) -- [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (:read) -- [`PUT /orgs/:org/blocks/:username`](/rest/reference/orgs#block-a-user-from-an-organization) (:write) -- [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (:write) +- [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (read) +- [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (read) +- [`PUT /orgs/:org/blocks/:username`](/rest/reference/orgs#block-a-user-from-an-organization) (write) +- [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (write) {% endif %} -## Permission on "pages" + +## Organization webhooks + +- [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (read) +- [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (write) +- [`GET /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#get-an-organization-webhook) (read) +- [`PATCH /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#update-an-organization-webhook) (write) +- [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (write) +- [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (write) + +### Teams +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) + + +## Pages GitHub Pages can only be created or unpublished by a repository owner or administrator. -- [`GET /repos/:owner/:repo/pages`](/rest/reference/pages#get-a-github-pages-site) (:read) -- [`PUT /repos/:owner/:repo/pages`](/rest/reference/pages#update-information-about-a-github-pages-site) (:write) -- [`GET /repos/:owner/:repo/pages/builds`](/rest/reference/pages#list-github-pages-builds) (:read) -- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/pages#request-a-github-pages-build) (:write) -- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/pages#get-github-pages-build) (:read) -- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/pages#get-latest-pages-build) (:read) +- [`GET /repos/:owner/:repo/pages`](/rest/reference/pages#get-a-github-pages-site) (read) +- [`PUT /repos/:owner/:repo/pages`](/rest/reference/pages#update-information-about-a-github-pages-site) (write) +- [`GET /repos/:owner/:repo/pages/builds`](/rest/reference/pages#list-github-pages-builds) (read) +- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/pages#request-a-github-pages-build) (write) +- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/pages#get-github-pages-build) (read) +- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/pages#get-latest-pages-build) (read) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (:write) -- [`POST /repos/:owner/:repo/pages/deployment`](/rest/reference/repos#create-a-github-pages-deployment) (:write) +- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (write) +- [`POST /repos/:owner/:repo/pages/deployment`](/rest/reference/repos#create-a-github-pages-deployment) (write) {% endif %} -## Permission on "pull requests" + +## Profile + +- [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (write) + + +## Pull requests Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. -- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (:read) -- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (:read) -- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/pulls`](/rest/reference/pulls#list-pull-requests) (:read) -- [`POST /repos/:owner/:repo/pulls`](/rest/reference/pulls#create-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#get-a-pull-request) (:read) -- [`PATCH /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#update-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#list-review-comments-on-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/commits`](/rest/reference/pulls#list-commits-on-a-pull-request) (:read) -- [`GET /repos/:owner/:repo/pulls/:pull_number/files`](/rest/reference/pulls#list-pull-requests-files) (:read) -- [`GET /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) (:read) -- [`GET /repos/:owner/:repo/pulls/comments`](/rest/reference/pulls#list-review-comments-in-a-repository) (:read) -- [`GET /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) (:read) -- [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (:write) +- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (read) +- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (read) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (read) +- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/pulls`](/rest/reference/pulls#list-pull-requests) (read) +- [`POST /repos/:owner/:repo/pulls`](/rest/reference/pulls#create-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#get-a-pull-request) (read) +- [`PATCH /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#update-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#list-review-comments-on-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/commits`](/rest/reference/pulls#list-commits-on-a-pull-request) (read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/files`](/rest/reference/pulls#list-pull-requests-files) (read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) (read) +- [`GET /repos/:owner/:repo/pulls/comments`](/rest/reference/pulls#list-review-comments-in-a-repository) (read) +- [`GET /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) (read) +- [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (write) ### Assignees -- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) -- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) +- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (read) +- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (write) ### Events -- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) -- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (read) +- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (write) ### Labels -- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (:write) -- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (:write) -- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (:read) -- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) -- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (write) +- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (read) +- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (write) +- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (read) +- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (write) +- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (write) ### Milestones -- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) -- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) -- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (:write) -- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) +- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (read) +- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (read) +- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (write) +- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (read) ### Reactions -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) (:read) -- [`POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) (:write) -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) (read) +- [`POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) (write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) ### Requested reviewers -- [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (:write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (write) ### Reviews -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (:read) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#update-a-review-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#delete-a-pending-review-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (:read) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (:write) - -## Permission on "profile" - -- [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (:write) - -## Permission on "repository hooks" - -- [`GET /repos/:owner/:repo/hooks`](/rest/reference/webhooks#list-repository-webhooks) (:read) -- [`POST /repos/:owner/:repo/hooks`](/rest/reference/webhooks#create-a-repository-webhook) (:write) -- [`GET /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#get-a-repository-webhook) (:read) -- [`PATCH /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#update-a-repository-webhook) (:write) -- [`DELETE /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#delete-a-repository-webhook) (:write) -- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/rest/reference/webhooks#ping-a-repository-webhook) (:read) -- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (:read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (read) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#update-a-review-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#delete-a-pending-review-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (read) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (write) {% ifversion ghes %} -## Permission on "repository pre receive hooks" + +## Repository pre-receive hooks -- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (:read) -- [`PATCH /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (:write) +- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (read) +- [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (read) +- [`PATCH /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (write) {% endif %} -## Permission on "repository projects" + +## Repository projects -- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) -- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) -- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (:write) -- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (:read) -- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (:write) -- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (:read) -- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (:write) -- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (:write) -- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (:read) -- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (:write) -- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (:read) -- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (:write) -- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (:write) -- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) -- [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (:read) -- [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (:write) +- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (read) +- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (write) +- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (write) +- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (read) +- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (write) +- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (read) +- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (write) +- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (write) +- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (read) +- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (write) +- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (read) +- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (write) +- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (write) +- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (write) +- [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (read) +- [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (write) ### Teams -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) + + +## Repository webhooks + +- [`GET /repos/:owner/:repo/hooks`](/rest/reference/webhooks#list-repository-webhooks) (read) +- [`POST /repos/:owner/:repo/hooks`](/rest/reference/webhooks#create-a-repository-webhook) (write) +- [`GET /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#get-a-repository-webhook) (read) +- [`PATCH /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#update-a-repository-webhook) (write) +- [`DELETE /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#delete-a-repository-webhook) (write) +- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/rest/reference/webhooks#ping-a-repository-webhook) (read) +- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (read) {% ifversion fpt or ghec %} -## Permission on "secrets" + +## Secrets -- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:read) -- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:read) -- [`GET /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#get-a-repository-secret) (:read) -- [`PUT /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-a-repository-secret) (:write) -- [`DELETE /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#delete-a-repository-secret) (:write) -- [`GET /orgs/:org/actions/secrets/public-key`](/rest/reference/actions#get-an-organization-public-key) (:read) -- [`GET /orgs/:org/actions/secrets`](/rest/reference/actions#list-organization-secrets) (:read) -- [`GET /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#get-an-organization-secret) (:read) -- [`PUT /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-an-organization-secret) (:write) -- [`GET /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) (:read) -- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) (:write) -- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#add-selected-repository-to-an-organization-secret) (:write) -- [`DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) (:write) -- [`DELETE /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#delete-an-organization-secret) (:write) -{% endif %} - -{% ifversion fpt or ghec or ghes > 3.3%} -## Permission on "dependabot_secrets" -- [`GET /repos/:owner/:repo/dependabot/secrets/public-key`](/rest/reference/dependabot#get-a-repository-public-key) (:read) -- [`GET /repos/:owner/:repo/dependabot/secrets`](/rest/reference/dependabot#list-repository-secrets) (:read) -- [`GET /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-a-repository-secret) (:read) -- [`PUT /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-a-repository-secret) (:write) -- [`DELETE /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-a-repository-secret) (:write) -- [`GET /orgs/:org/dependabot/secrets/public-key`](/rest/reference/dependabot#get-an-organization-public-key) (:read) -- [`GET /orgs/:org/dependabot/secrets`](/rest/reference/dependabot#list-organization-secrets) (:read) -- [`GET /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-an-organization-secret) (:read) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-an-organization-secret) (:write) -- [`GET /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret) (:read) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) (:write) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#add-selected-repository-to-an-organization-secret) (:write) -- [`DELETE /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) (:write) -- [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (read) +- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (read) +- [`GET /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#get-a-repository-secret) (read) +- [`PUT /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-a-repository-secret) (write) +- [`DELETE /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#delete-a-repository-secret) (write) +- [`GET /orgs/:org/actions/secrets/public-key`](/rest/reference/actions#get-an-organization-public-key) (read) +- [`GET /orgs/:org/actions/secrets`](/rest/reference/actions#list-organization-secrets) (read) +- [`GET /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#get-an-organization-secret) (read) +- [`PUT /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-an-organization-secret) (write) +- [`GET /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) (read) +- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) (write) +- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#add-selected-repository-to-an-organization-secret) (write) +- [`DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) (write) +- [`DELETE /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#delete-an-organization-secret) (write) {% endif %} {% ifversion ghes or ghec %} -## Permission on "secret scanning alerts" + +## Secret scanning alerts -- [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (:read) -- [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) -- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations`](/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert) (:read) +- [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (read) +- [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (write) +- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations`](/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert) (read) {% endif %} -## Permission on "security events" - -- [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) -- [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (:write) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (:read) -{% endif -%} -- [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (:read) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (:read) -{% endif -%} -{% ifversion fpt or ghec or ghes -%} -- [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (:write) -{% endif -%} -- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (:write) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (:read) -{% endif -%} -{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 -%} -- [`GET /orgs/:org/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-by-organization) (:read) -{% endif -%} - {% ifversion fpt or ghes or ghec %} -## Permission on "self-hosted runners" -- [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (:write) -- [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (:read) -- [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (:write) -- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (:write) -- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (:write) + +## Self-hosted runners + +- [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (write) +- [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (read) +- [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (write) +- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (write) +- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (write) {% endif %} -## Permission on "single file" + +## Single file -- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) -- [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (:write) -- [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (:write) +- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (read) +- [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (write) +- [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (write) -## Permission on "starring" + +## Starring -- [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (:read) -- [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (:write) -- [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (:write) +- [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (read) +- [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (write) +- [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (write) -## Permission on "statuses" + +## Team discussions -- [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/commits#list-commit-statuses-for-a-reference) (:read) -- [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/commits#create-a-commit-status) (:write) - -## Permission on "team discussions" - -- [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (:read) -- [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#get-a-discussion) (:read) -- [`PATCH /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#update-a-discussion) (:write) -- [`DELETE /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#delete-a-discussion) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#list-discussion-comments) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#create-a-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#get-a-discussion-comment) (:read) -- [`PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#update-a-discussion-comment) (:write) -- [`DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#delete-a-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion) (:write) +- [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (read) +- [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (write) +- [`GET /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#get-a-discussion) (read) +- [`PATCH /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#update-a-discussion) (write) +- [`DELETE /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#delete-a-discussion) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#list-discussion-comments) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#create-a-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#get-a-discussion-comment) (read) +- [`PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#update-a-discussion-comment) (write) +- [`DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#delete-a-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion) (write) diff --git a/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index dcf929a857..4e6d036ae3 100644 --- a/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/es-ES/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -268,7 +268,7 @@ You can filter pull requests based on their [review status](/pull-requests/colla | reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) matches pull requests reviewed by a particular person. | review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) matches pull requests where a specific person is requested for review. Requested reviewers are no longer listed in the search results after they review a pull request. If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} | user-review-requested:@me | [**type:pr user-review-requested:@me**](https://github.com/search?q=is%3Apr+user-review-requested%3A%40me+) matches pull requests that you have directly been asked to review.{% endif %} -| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) matches pull requests that have review requests from the team `atom/design`. Requested reviewers are no longer listed in the search results after they review a pull request. +| team-review-requested:TEAMNAME | [**type:pr team-review-requested:github/docs**](https://github.com/search?q=type%3Apr+team-review-requested%3Agithub%2Fdocs&type=pullrequests) matches pull requests that have review requests from the team `github/docs`. Requested reviewers are no longer listed in the search results after they review a pull request. ## Search by when an issue or pull request was created or last updated diff --git a/translations/es-ES/data/reusables/actions/link-to-example-library.md b/translations/es-ES/data/reusables/actions/link-to-example-library.md deleted file mode 100644 index 0a97f0e866..0000000000 --- a/translations/es-ES/data/reusables/actions/link-to-example-library.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -ms.openlocfilehash: ad73c4455042d29d72d3f76dbbdc512487c9303a -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: "146139476" ---- -Para ver ejemplos que demuestren características más complejas de {% data variables.product.prodname_actions %}, consulta "[Ejemplos](/actions/examples)". Para ver ejemplos detallados que explican cómo probar el código en un ejecutor, accede a la CLI de {% data variables.product.prodname_dotcom %} y usa características avanzadas, como la simultaneidad y las matrices de prueba. diff --git a/translations/es-ES/data/reusables/apps/metadata-permissions.md b/translations/es-ES/data/reusables/apps/metadata-permissions.md deleted file mode 100644 index c1d2074ba0..0000000000 --- a/translations/es-ES/data/reusables/apps/metadata-permissions.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -ms.openlocfilehash: 5cbe77b1e8580e79c7e77b99de3e1973191d2075 -ms.sourcegitcommit: 5b1461b419dbef60ae9dbdf8e905a4df30fc91b7 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/10/2022 -ms.locfileid: "147879335" ---- -Si establece el permiso de metadatos en `No access` y selecciona un permiso que necesita acceso al repositorio, GitHub invalidará la selección y volverá a establecer el permiso de metadatos en `Read-only`. Para establecer el permiso de metadatos en `No access`, primero debe establecer en `No access` todos los permisos que necesiten acceso al repositorio. diff --git a/translations/es-ES/data/reusables/codespaces/creating-a-codespace-in-vscode.md b/translations/es-ES/data/reusables/codespaces/creating-a-codespace-in-vscode.md index 4f150af299..c89126ae76 100644 --- a/translations/es-ES/data/reusables/codespaces/creating-a-codespace-in-vscode.md +++ b/translations/es-ES/data/reusables/codespaces/creating-a-codespace-in-vscode.md @@ -15,6 +15,8 @@ After you connect your account on {% data variables.product.product_location %} ![Searching for repository to create a new codespace](/assets/images/help/codespaces/choose-repository-vscode.png) + If codespaces are billable for the repository you choose, a message will be displayed in subsequent prompts telling you who will pay for the codespace. + 4. Click the branch you want to develop on. ![Searching for a branch to create a new codespace](/assets/images/help/codespaces/choose-branch-vscode.png) diff --git a/translations/es-ES/data/reusables/notifications/vulnerable-dependency-notification-options.md b/translations/es-ES/data/reusables/notifications/vulnerable-dependency-notification-options.md index 75b374e2bb..4f702e6e70 100644 --- a/translations/es-ES/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/translations/es-ES/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -1,27 +1,22 @@ ---- -ms.openlocfilehash: 5120f840aab87ca243eed66c5bb6256e80aefeea -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: es-ES -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147064182" ---- -{% ifversion fpt or ghec %}De manera predeterminada, recibirás notificaciones:{% endif %}{% ifversion ghes or ghae %}De manera predeterminada, si el propietario de tu empresa ha configurado las notificaciones por correo electrónico en tu instancia, recibirás {% data variables.product.prodname_dependabot_alerts %}:{% endif %} +{% ifversion fpt or ghec %}By default, you will receive notifications:{% endif %}{% ifversion ghes or ghae %}By default, if your enterprise owner has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} -- por correo electrónico, se enviará un mensaje de correo electrónico cuando se habilite {% data variables.product.prodname_dependabot %} para un repositorio, cuando se confirme un archivo de manifiesto nuevo en el repositorio y cuando se encuentre una vulnerabilidad nueva de gravedad crítica o alta (la opción **Email each time a vulnerability is found**). -- en la interfaz de usuario, se muestra una advertencia en las vistas de archivos y código del repositorio si hay dependencias no seguras (opción **Alertas de la interfaz de usuario**). -- en la línea de comandos, las advertencias se muestran como devoluciones de llamada al insertar en repositorios con dependencias no seguras (opción **Línea de comandos**). -- en la bandeja de entrada, como notificaciones web. Se enviará una notificación web cuando se habilite {% data variables.product.prodname_dependabot %} en un repositorio, cuando se confirme un archivo de manifiesto nuevo en el repositorio y cuando se encuentre una vulnerabilidad nueva con gravedad crítica o alta (la opción **Web**).{% ifversion not ghae %} -- en {% data variables.product.prodname_mobile %}, como notificaciones web. Para más información, vea ["Habilitación de notificaciones de inserción con GitHub Mobile](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)".{% endif %} +- by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email each time a vulnerability is found** option). +- in the user interface, a warning is shown in your repository's file and code views if there are any insecure dependencies (**UI alerts** option). +- on the command line, warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**Command Line** option). +- in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Web** option).{% ifversion not ghae %} +- on {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[Enabling push notifications with GitHub Mobile](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)."{% endif %} {% note %} -**Nota:** Las notificaciones por correo electrónico y web{% ifversion not ghae %}/{% data variables.product.prodname_mobile %}{% endif %} son las siguientes: +**Note:** The email and web{% ifversion not ghae %}/{% data variables.product.prodname_mobile %}{% endif %} notifications are: -- _por repositorio_ cuando {% data variables.product.prodname_dependabot %} se habilita en el repositorio o cuando se confirma un archivo de manifiesto nuevo en el repositorio. +- _per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. -- _por organización_ cuando se descubre una vulnerabilidad nueva. +- _per organization_ when a new vulnerability is discovered. {% endnote %} -Puede personalizar la forma en que recibe notificaciones sobre {% data variables.product.prodname_dependabot_alerts %}. Por ejemplo, puede recibir un correo electrónico semanal con el resumen de las alertas de hasta 10 de los repositorios mediante las opciones **Email a digest summary of vulnerabilities** y **Weekly security email digest**. +{% ifversion update-notification-settings-22 %} +You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a daily or weekly digest email summarizing alerts for up to 10 of your repositories using the **Email weekly digest** option. +{% else %} +You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the **Email a digest summary of vulnerabilities** and **Weekly security email digest** options.{% endif %} diff --git a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md index 361157b332..8d2d85b673 100644 --- a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md +++ b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md @@ -1,6 +1,6 @@ --- -title: サブスクリプションを表示する -intro: 通知の送信元と通知のボリュームを把握するため、定期的にサブスクリプションを確認し、リポジトリを Watch することをお勧めします。 +title: Viewing your subscriptions +intro: 'To understand where your notifications are coming from and your notifications volume, we recommend reviewing your subscriptions and watched repositories regularly.' redirect_from: - /articles/subscribing-to-conversations - /articles/unsubscribing-from-conversations @@ -24,63 +24,61 @@ versions: topics: - Notifications shortTitle: View subscriptions -ms.openlocfilehash: 34faad79004d34f5beb14e8992b9aff4e6a3ab39 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/10/2022 -ms.locfileid: '145117238' --- -{% data variables.product.product_name %} で進行中のアクティビティのサブスクリプションの通知を受け取ります。 会話をサブスクライブする理由はたくさんあります。 詳細については、「[通知について](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)」を参照してください。 +You receive notifications for your subscriptions of ongoing activity on {% data variables.product.product_name %}. There are many reasons you can be subscribed to a conversation. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)." -健全な通知ワークフローの一環として、サブスクリプションの監査とサブスクライブ解除をお勧めします。 登録解除のオプションの詳細については、「[サブスクリプションの管理」を](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)参照してください。 +We recommend auditing and unsubscribing from your subscriptions as a part of a healthy notifications workflow. For more information about your options for unsubscribing, see "[Managing subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." -## 通知過多の理由を診断する +## Diagnosing why you receive too many notifications -インボックスの通知が多すぎて管理できない場合は、サブスクリプションが多すぎないか確認したり、通知設定を変更して、サブスクリプションと受信する通知の種類を減らしたりすることを検討してください。 たとえば、設定を無効にして、チームまたはリポジトリに参加するたびにすべてのリポジトリとすべての Team ディスカッションを自動的に監視することを検討できます。 +When your inbox has too many notifications to manage, consider whether you have oversubscribed or how you can change your notification settings to reduce the subscriptions you have and the types of notifications you're receiving. For example, you may consider disabling the settings to automatically watch all repositories and all team discussions whenever you've joined a team or repository. -![自動 Watch](/assets/images/help/notifications-v2/automatic-watching-example.png) +{% ifversion update-notification-settings-22 %} +![Screenshot of automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png) +{% else %} +![Screenshot of automatic watching options for teams and repositories](/assets/images/help/notifications-v2/automatic-watching-example.png){% endif %} -詳細については、「[通知の設定](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)」を参照してください。 +For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)." -リポジトリのサブスクリプションの概要を確認するには、「[Watch しているリポジトリを確認する](#reviewing-repositories-that-youre-watching)」を参照してください。 {% tip %} +To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)." +{% tip %} -**ヒント:** 通知するイベントの種類を選択するには、**監視ページ** の **[Watch/Watch 解除]** ドロップダウン リストの [[カスタム]](https://github.com/watching) オプションを使用するか、{% data variables.product.product_name %} の任意のリポジトリ ページを使用します。 詳細については、「[通知の設定](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)」を参照してください。 +**Tip:** You can select the types of event to be notified of by using the **Custom** option of the **Watch/Unwatch** dropdown list in your [watching page](https://github.com/watching) or on any repository page on {% data variables.product.product_name %}. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endtip %} -過去に Watch することを選択したリポジトリが忘れらていることが多くあります。 「Watched repositories」ページから、リポジトリから素早く Watch 解除することができます。 サブスクライブ解除する方法について詳しくは、{% data variables.product.prodname_blog %} の「[Watch 解除の推奨](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)」および「[サブスクリプションを管理する](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)」を参照してください。 トリアージワークフローを作成して、受信する通知を支援することもできます。 トリアージ ワークフローのガイダンスについては、「[通知をトリアージするためのワークフローのカスタマイズ](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)」を参照してください。 +Many people forget about repositories that they've chosen to watch in the past. From the "Watched repositories" page you can quickly unwatch repositories. For more information on ways to unsubscribe, see "[Unwatch recommendations](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" on {% data variables.product.prodname_blog %} and "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." You can also create a triage workflow to help with the notifications you receive. For guidance on triage workflows, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)." -## サブスクリプションのリストを確認する +## Reviewing all of your subscriptions {% data reusables.notifications.access_notifications %} -1. 左側のサイドバーの、通知元のリポジトリリストの下にある [通知の管理] ドロップダウンを使用して、 **[サブスクリプション]** をクリックします。 - ![[通知の管理] ドロップダウン メニュー オプション](/assets/images/help/notifications-v2/manage-notifications-options.png) +1. In the left sidebar, under the list of repositories that you have notifications from, use the "Manage notifications" drop-down to click **Subscriptions**. + ![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. フィルタとソートを使用して、サブスクリプションのリストを絞り込み、通知の受信を希望しない会話のサブスクリプションを解除します。 +2. Use the filters and sort to narrow the list of subscriptions and begin unsubscribing to conversations you no longer want to receive notifications for. - ![サブスクリプションページ](/assets/images/help/notifications-v2/all-subscriptions.png) + ![Subscriptions page](/assets/images/help/notifications-v2/all-subscriptions.png) {% tip %} -**ヒント:** -- 忘れている可能性のあるサブスクリプションを確認するには、[least recently subscribed] でソートします。 +**Tips:** +- To review subscriptions you may have forgotten about, sort by "least recently subscribed." -- 引き続き通知が受信可能なリポジトリのリストを確認するには、[filter by repository] ドロップダウンメニューのリポジトリリストを参照します。 +- To review a list of repositories that you can still receive notifications for, see the repository list in the "filter by repository" drop-down menu. {% endtip %} -## Watch しているリポジトリを確認する +## Reviewing repositories that you're watching -1. 左側のサイドバーの、リポジトリ リストの下にある [通知の管理] ドロップダウン メニューを使用して、 **[Watched repositories]** をクリックします。 - ![[通知の管理] ドロップダウン メニュー オプション](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Watch しているリポジトリを評価し、それらの更新がまだ関連していて有用であるかどうかを判断します。 リポジトリを Watch すると、そのリポジトリのすべての会話が通知されます。 -![Watch 対象の通知ページ](/assets/images/help/notifications-v2/watched-notifications-custom.png) +1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**. + ![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png) +2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository. +![Watched notifications page](/assets/images/help/notifications-v2/watched-notifications-custom.png) {% tip %} - **ヒント:** リポジトリを監視する代わりに、{% data reusables.notifications-v2.custom-notification-types %} (リポジトリで有効になっている場合) の更新がある場合、またはこれらのオプションの任意の組み合わせがある場合にのみ通知を受信するか、リポジトリの監視を完全に解除することを検討してください。 + **Tip:** Instead of watching a repository, consider only receiving notifications when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options, or completely unwatching a repository. - リポジトリの Watch を解除しても、@mentioned されたときやスレッドに参加しているときには通知を受信することができます。 特定のイベント タイプの通知を受信するように設定すると、リポジトリにこれらのイベント タイプが更新された場合、スレッドに参加している場合、または参加している自分またはチームが @mentioned された場合にのみ通知されます。 + When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned. {% endtip %} diff --git a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index 35d44edfe8..f0ec8c75e9 100644 --- a/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -79,15 +79,27 @@ You can customize notifications for a repository. For example, you can choose to ### Participating in conversations Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox. -For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}. +{% ifversion update-notification-settings-22 %}For conversations you're watching or participating in, you can choose whether you want to receive notifications on {% data variables.product.company_short %} or by email in your notification settings. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." + +![Animated GIF of participating and watching subscriptions options](/assets/images/help/notifications/selecting-participating-notifications.gif) + +{% else %} + +For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion ghes %} and {% data variables.product.prodname_mobile %}{% endif %}. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." + +![Screenshot of participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png){% endif %} + -![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png) For example: - If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications. - If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating". -If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates. +{% ifversion update-notification-settings-22 %}If you do not enable "Notify me: On GitHub" for watching or participating notifications, then your notifications inbox will not have any updates. + +{% else %} + +If you do not enable watching or participating notifications for web{% ifversion ghes %} and mobile{% endif %}, then your notifications inbox will not have any updates.{% endif %} ## Customizing your email notifications @@ -146,11 +158,16 @@ Email notifications from {% data variables.product.product_location %} contain t ## Automatic watching -By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options. +By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options in your notification settings. - ![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png) +{% ifversion update-notification-settings-22 %} +![Automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png) +{% else %} +![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png){% endif %} -If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. +If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. + +For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." ## Configuring your watch settings for an individual repository @@ -172,9 +189,17 @@ If you belong to an organization, you can choose the email account you want noti {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} + 3. Under "Default notification email", select the email address you'd like notifications sent to. -![Default notification email address drop-down](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) -4. Click **Save**. +{% ifversion update-notification-settings-22 %} + + ![Screenshot of the default notification email address setting](/assets/images/help/notifications/default-email-address-emphasized.png) + +{% else %} + + ![Screenshot of the default notification email address dropdown](/assets/images/help/notifications/notifications_primary_email_for_orgs.png){% endif %} +{% ifversion ghes or ghae %} +4. Click **Save**.{% endif %} ### Customizing email routes per organization @@ -182,12 +207,35 @@ If you are a member of more than one organization, you can configure each one to {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. Under "Custom routing," find your organization's name in the list. -![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) +{% ifversion update-notification-settings-22 %} +3. Under "Default notifications email", click **Custom routing**. + + ![Screenshot of default notifications email settings with custom routing button emphasised](/assets/images/help/notifications/custom-router-emphasized.png) + +4. Click **Add new route**. + + ![Screenshot of custom routing settings with add new route button emphasised](/assets/images/help/notifications/add-new-route-emphasized.png) + +5. Click **Pick organization**, then select the organization you want to customize from the dropdown. + + ![Screenshot of dropdown to pick organization](/assets/images/help/notifications/organization-dropdown-custom-routing-emphasis.png) + +6. Select one of your verified email addresses, then click **Save**. + + ![Screenshot of custom routing page with save button](/assets/images/help/notifications/select-email-address-custom-routing-and-save.png) + +{% else %} +3. Under "Custom routing," find your organization's name in the list. + + ![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) + 4. Click **Edit** next to the email address you want to change. -![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) + + ![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) + 5. Select one of your verified email addresses, then click **Save**. -![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif) + + ![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif){% endif %} ## {% data variables.product.prodname_dependabot_alerts %} notification options @@ -197,14 +245,17 @@ If you are a member of more than one organization, you can configure each one to For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts)." -{% ifversion fpt or ghes or ghec %} +{% ifversion update-notification-settings-22 or ghes %} ## {% data variables.product.prodname_actions %} notification options -Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs. +Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs.{% endif %} - ![Notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png) +{% ifversion update-notification-settings-22 %} +![Animated GIF of notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications/github-actions-customize-notifications.gif){% endif %} + +{% ifversion ghes %} + ![Screenshot of the notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png){% endif %} -{% endif %} {% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} ## Organization alerts notification options diff --git a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md index 3c6473026b..c0511693a3 100644 --- a/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md +++ b/translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md @@ -1,6 +1,6 @@ --- -title: プロフィールの README を管理する -intro: '{% data variables.product.prodname_dotcom %} プロフィールに README を追加して、他のユーザに自分の情報を伝えることができます。' +title: Managing your profile README +intro: 'You can add a README to your {% data variables.product.prodname_dotcom %} profile to tell other people about yourself.' versions: fpt: '*' ghes: '*' @@ -11,71 +11,67 @@ redirect_from: - /github/setting-up-and-managing-your-github-profile/managing-your-profile-readme - /github/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme shortTitle: Your profile README -ms.openlocfilehash: 587bcea1e1a0f96aad8882b41196afcc6e433363 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147578901' --- -## プロフィール README について +## About your profile README -プロフィール README を作成すると、{% data variables.product.product_location %} で自分に関する情報をコミュニティと共有できます。 {% data variables.product.prodname_dotcom %} では、プロフィールページの上部にプロフィール README が表示されます。 +You can share information about yourself with the community on {% data variables.product.product_location %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page. -プロフィール README に含める情報を決めることができるため、{% data variables.product.prodname_dotcom %} で自分に関するどのような情報を表示するかを完全に制御できます。 アクセスしたユーザがあなたのプロフィール README を見て、興味深い、楽しい、役立つと感じる可能性のある情報の例は次のとおりです。 +You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README. -- あなたの仕事や興味について説明した「自己紹介」セクション -- あなたが誇りに思っているコントリビューションとそれらのコントリビューションについてのコンテキスト -- あなたが関連しているコミュニティでサポートを得るためのガイド +- An "About me" section that describes your work and interests +- Contributions you're proud of, and context about those contributions +- Guidance for getting help in communities where you're involved -![プロフィールに表示されるプロフィール README ファイル](/assets/images/help/repository/profile-with-readme.png) +![Profile README file displayed on profile](/assets/images/help/repository/profile-with-readme.png) -{% data variables.product.company_short %} Flavored Markdown を使用して、テキストをフォーマットし、絵文字、画像、GIF をプロフィール README に含めることができます。 詳細については、「[{% data variables.product.prodname_dotcom %} での書き込みと書式設定の概要](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)」を参照してください。 +You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)." For a hands-on guide to customizing your profile README, see "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)." -## 前提条件 +## Prerequisites -次のすべてが当てはまる場合、GitHubは プロフィールページにプロフィール README を表示します。 +GitHub will display your profile README on your profile page if all of the following are true. -- {% data variables.product.prodname_dotcom %} ユーザ名にマッチする名前のリポジトリを作成した。 -- リポジトリがパブリックである。 -- リポジトリのルートに README.md という名前のファイルが含まれている。 -- README.md ファイルに任意のコンテンツが含まれている。 +- You've created a repository with a name that matches your {% data variables.product.prodname_dotcom %} username. +- The repository is public. +- The repository contains a file named README.md in its root. +- The README.md file contains any content. {% note %} -**注**: 2020 年 7 月以前にユーザー名と同名のパブリック リポジトリを作成していた場合、{% data variables.product.prodname_dotcom %} のプロフィールにはリポジトリの README が自動的に表示されません。 {% data variables.product.prodname_dotcom_the_website %} のリポジトリに移動して、 **[プロフィールで共有]** をクリックすると、リポジトリの README をプロフィールで手動で共有できます。 +**Note**: If you created a public repository with the same name as your username before July 2020, {% data variables.product.prodname_dotcom %} won't automatically show the repository's README on your profile. You can manually share the repository's README to your profile by going to the repository on {% data variables.product.prodname_dotcom_the_website %} and clicking **Share to profile**. -![README をプロフィールに共有するためのボタン](/assets/images/help/repository/share-to-profile.png) +![Button to share README to profile](/assets/images/help/repository/share-to-profile.png) {% endnote %} -## プロフィールの README を追加する +## Adding a profile README {% data reusables.repositories.create_new %} -2. [Repository name] の下に、{% data variables.product.prodname_dotcom %} のユーザ名とマッチするリポジトリ名を入力します。 たとえば、ユーザ名が「octocat」の場合、リポジトリ名は「octocat」である必要があります。 - ![ユーザー名に一致する [リポジトリ名] フィールド](/assets/images/help/repository/repo-username-match.png) -3. 必要に応じて、リポジトリの説明を追加します。 たとえば、「個人リポジトリ」などです。 - ![リポジトリの説明を入力するフィールド](/assets/images/help/repository/create-personal-repository-desc.png) -4. **[パブリック]** を選択します。 - ![可視性を選択するためのオプション ボタン ([パブリック] が選択された状態)](/assets/images/help/repository/create-personal-repository-visibility.png) {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -7. 右側のサイドバーの上にある **[README の編集]** をクリックします。 - ![README ファイルを編集するためのボタン](/assets/images/help/repository/personal-repository-edit-readme.png) +2. Under "Repository name", type a repository name that matches your {% data variables.product.prodname_dotcom %} username. For example, if your username is "octocat", the repository name must be "octocat". + ![Repository name field which matches username](/assets/images/help/repository/repo-username-match.png) +3. Optionally, add a description of your repository. For example, "My personal repository." + ![Field for entering a repository description](/assets/images/help/repository/create-personal-repository-desc.png) +4. Select **Public**. + ![Radio button to select visibility with public selected](/assets/images/help/repository/create-personal-repository-visibility.png) +{% data reusables.repositories.initialize-with-readme %} +{% data reusables.repositories.create-repo %} +7. Above the right sidebar, click **Edit README**. + ![Button to edit README file](/assets/images/help/repository/personal-repository-edit-readme.png) - 生成された README ファイルには、プロフィール README のアイディアを得るためのテンプレートが事前入力されています。 - ![テンプレートが事前入力された README ファイル](/assets/images/help/repository/personal-repository-readme-template.png) + The generated README file is pre-populated with a template to give you some inspiration for your profile README. + ![README file with pre-populated template](/assets/images/help/repository/personal-repository-readme-template.png) -使用できるすべての絵文字とそのコードの概要については、[絵文字のチート シート](https://www.webfx.com/tools/emoji-cheat-sheet/)を参照してください。 +For a summary of all the available emojis and their codes, see "[Emoji cheat sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)." -## プロフィール README を削除する +## Removing a profile README -次のいずれかに該当する場合、プロフィール README は {% data variables.product.prodname_dotcom %} のプロフィールから削除されます。 +The profile README is removed from your {% data variables.product.prodname_dotcom %} profile if any of the following apply: -- README ファイルが空であるか、存在しない。 -- リポジトリがプライベートである。 -- リポジトリ名がユーザ名とマッチしなくなった。 +- The README file is empty or doesn't exist. +- The repository is private. +- The repository name no longer matches your username. -The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. リポジトリをプライベートにする方法については、「[リポジトリの可視性を変更する](/github/administering-a-repository/setting-repository-visibility#changing-a-repositorys-visibility)」を参照してください。 +The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see "[Changing a repository's visibility](/github/administering-a-repository/setting-repository-visibility#changing-a-repositorys-visibility)." -## 参考資料 +## Further reading -- [README について](/github/creating-cloning-and-archiving-repositories/about-readmes) +- [About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes) diff --git a/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md b/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md index 6a56652420..66fc48555f 100644 --- a/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md +++ b/translations/ja-JP/content/actions/creating-actions/creating-a-javascript-action.md @@ -1,5 +1,6 @@ --- title: Creating a JavaScript action +shortTitle: Create a JavaScript action intro: 'In this guide, you''ll learn how to build a JavaScript action using the actions toolkit.' redirect_from: - /articles/creating-a-javascript-action @@ -15,7 +16,6 @@ type: tutorial topics: - Action development - JavaScript -shortTitle: JavaScript action --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/ja-JP/content/actions/creating-actions/releasing-and-maintaining-actions.md b/translations/ja-JP/content/actions/creating-actions/releasing-and-maintaining-actions.md index a75f639e0f..fd9070d47d 100644 --- a/translations/ja-JP/content/actions/creating-actions/releasing-and-maintaining-actions.md +++ b/translations/ja-JP/content/actions/creating-actions/releasing-and-maintaining-actions.md @@ -1,6 +1,6 @@ --- title: Releasing and maintaining actions -shortTitle: Releasing and maintaining actions +shortTitle: Release and maintain actions intro: You can leverage automation and open source best practices to release and maintain actions. type: tutorial topics: diff --git a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index c32e7dc1d5..9d8f3e75a0 100644 --- a/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/translations/ja-JP/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -1,6 +1,6 @@ --- title: Configuring OpenID Connect in HashiCorp Vault -shortTitle: Configuring OpenID Connect in HashiCorp Vault +shortTitle: OpenID Connect in HashiCorp Vault intro: Use OpenID Connect within your workflows to authenticate with HashiCorp Vault. miniTocMaxHeadingLevel: 3 versions: diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 053f0e3d1e..89ba5d874e 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -1,5 +1,6 @@ --- title: Autoscaling with self-hosted runners +shortTitle: Autoscale self-hosted runners intro: You can automatically scale your self-hosted runners in response to webhook events. versions: fpt: '*' @@ -63,7 +64,7 @@ By default, self-hosted runners will automatically perform a software update whe To turn off automatic software updates and install software updates yourself, specify the `--disableupdate` flag when registering your runner using `config.sh`. For example: ```shell -./config.sh --url https://github.com/octo-org --token example-token --disableupdate +./config.sh --url https://github.com/YOUR-ORGANIZATION --token EXAMPLE-TOKEN --disableupdate ``` If you disable automatic updates, you must still update your runner version regularly. New functionality in {% data variables.product.prodname_actions %} requires changes in both the {% data variables.product.prodname_actions %} service _and_ the runner software. The runner may not be able to correctly process jobs that take advantage of new features in {% data variables.product.prodname_actions %} without a software update. diff --git a/translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md index cf4ef299df..02a70e8c26 100644 --- a/translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/translations/ja-JP/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -59,7 +59,7 @@ For example: {% windows %} ```shell -run.cmd --check --url https://github.com/octo-org/octo-repo --pat ghp_abcd1234 +run.cmd --check --url https://github.com/YOUR-ORG/YOUR-REPO --pat GHP_ABCD1234 ``` {% endwindows %} @@ -79,7 +79,7 @@ To disable TLS certification verification in the self-hosted runner application, ```shell export GITHUB_ACTIONS_RUNNER_TLS_NO_VERIFY=1 -./config.sh --url https://github.com/octo-org/octo-repo --token +./config.sh --url https://github.com/YOUR-ORG/YOUR-REPO --token ./run.sh ``` diff --git a/translations/ja-JP/content/actions/learn-github-actions/contexts.md b/translations/ja-JP/content/actions/learn-github-actions/contexts.md index a4fdab860d..7a13b15687 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/contexts.md +++ b/translations/ja-JP/content/actions/learn-github-actions/contexts.md @@ -201,7 +201,7 @@ The `github` context contains information about the workflow run and the event t | `github.ref` | `string` | {% data reusables.actions.ref-description %} | {%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} | `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} | -| `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} | +| `github.ref_protected` | `boolean` | {% data reusables.actions.ref_protected-description %} | | `github.ref_type` | `string` | {% data reusables.actions.ref_type-description %} | {%- endif %} | `github.path` | `string` | Path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-commands-for-github-actions#adding-a-system-path)." | diff --git a/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md b/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md index 8569d3cf80..26a3fa7743 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -1,6 +1,6 @@ --- title: Finding and customizing actions -shortTitle: Finding and customizing actions +shortTitle: Find and customize actions intro: 'Actions are the building blocks that power your workflow. A workflow can contain actions created by the community, or you can create your own actions directly within your application''s repository. This guide will show you how to discover, use, and customize actions.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-github-marketplace-actions diff --git a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md index f3c1c1faf6..da677ef353 100644 --- a/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/ja-JP/content/actions/learn-github-actions/understanding-github-actions.md @@ -1,6 +1,6 @@ --- title: Understanding GitHub Actions -shortTitle: Understanding GitHub Actions +shortTitle: Understand GitHub Actions intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.' miniTocMaxHeadingLevel: 3 redirect_from: @@ -87,15 +87,9 @@ For more information, see "[Creating actions](/actions/creating-actions)." {% data reusables.actions.workflow-basic-example-and-explanation %} -## More complex examples -{% data reusables.actions.link-to-example-library %} - ## Next steps -- To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." -{% ifversion fpt or ghec or ghes %} -- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." -{% endif %} +{% data reusables.actions.onboarding-next-steps %} ## Contacting support diff --git a/translations/ja-JP/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md b/translations/ja-JP/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md index cc2359f7a5..2984bbaf48 100644 --- a/translations/ja-JP/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md +++ b/translations/ja-JP/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md @@ -1,5 +1,6 @@ --- title: Re-running workflows and jobs +shortTitle: Re-run workflows and jobs intro: 'You can re-run a workflow run{% ifversion re-run-jobs %}, all failed jobs in a workflow run, or specific jobs in a workflow run{% endif %} up to 30 days after its initial run.' permissions: People with write permissions to a repository can re-run workflows in the repository. miniTocMaxHeadingLevel: 3 @@ -48,14 +49,14 @@ Re-running a workflow{% ifversion re-run-jobs %} or jobs in a workflow{% endif % To re-run a failed workflow run, use the `run rerun` subcommand. Replace `run-id` with the ID of the failed run that you want to re-run. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id +gh run rerun RUN_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --debug +gh run rerun RUN_ID --debug ``` {% endif %} @@ -90,14 +91,14 @@ If any jobs in a workflow run failed, you can re-run just the jobs that failed. To re-run failed jobs in a workflow run, use the `run rerun` subcommand with the `--failed` flag. Replace `run-id` with the ID of the run for which you want to re-run failed jobs. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id --failed +gh run rerun RUN_ID --failed ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --failed --debug +gh run rerun RUN_ID --failed --debug ``` {% endif %} @@ -127,14 +128,14 @@ When you re-run a specific job in a workflow, a new workflow run will start for To re-run a specific job in a workflow run, use the `run rerun` subcommand with the `--job` flag. Replace `job-id` with the ID of the job that you want to re-run. ```shell -gh run rerun --job job-id +gh run rerun --job JOB_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun --job job-id --debug +gh run rerun --job JOB_ID --debug ``` {% endif %} diff --git a/translations/ja-JP/content/actions/publishing-packages/publishing-docker-images.md b/translations/ja-JP/content/actions/publishing-packages/publishing-docker-images.md index c56906a838..8f521c2664 100644 --- a/translations/ja-JP/content/actions/publishing-packages/publishing-docker-images.md +++ b/translations/ja-JP/content/actions/publishing-packages/publishing-docker-images.md @@ -1,5 +1,6 @@ --- title: Publishing Docker images +shortTitle: Publish Docker images intro: 'You can publish Docker images to a registry, such as Docker Hub or {% data variables.product.prodname_registry %}, as part of your continuous integration (CI) workflow.' redirect_from: - /actions/language-and-framework-guides/publishing-docker-images diff --git a/translations/ja-JP/content/actions/quickstart.md b/translations/ja-JP/content/actions/quickstart.md index b83df0ebe2..44f3ab36a3 100644 --- a/translations/ja-JP/content/actions/quickstart.md +++ b/translations/ja-JP/content/actions/quickstart.md @@ -77,21 +77,13 @@ Committing the workflow file to a branch in your repository triggers the `push` For example, you can see the list of files in your repository: ![Example action detail](/assets/images/help/repository/actions-quickstart-log-detail.png) - + +The example workflow you just added is triggered each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. For an in-depth tutorial, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)." + ## More starter workflows {% data reusables.actions.workflow-template-overview %} -## More complex examples -{% data reusables.actions.link-to-example-library %} - ## Next steps -The example workflow you just added runs each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. But this is only the beginning of what you can do with {% data variables.product.prodname_actions %}: - -- Your repository can contain multiple workflows that trigger different jobs based on different events. -- You can use a workflow to install software testing apps and have them automatically test your code on {% data variables.product.prodname_dotcom %}'s runners. - -{% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}: - -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial. +{% data reusables.actions.onboarding-next-steps %} diff --git a/translations/ja-JP/content/actions/security-guides/encrypted-secrets.md b/translations/ja-JP/content/actions/security-guides/encrypted-secrets.md index 9a60fda43d..e678c2474c 100644 --- a/translations/ja-JP/content/actions/security-guides/encrypted-secrets.md +++ b/translations/ja-JP/content/actions/security-guides/encrypted-secrets.md @@ -93,13 +93,13 @@ If your repository has environment secrets or can access secrets from the parent To add a repository secret, use the `gh secret set` subcommand. Replace `secret-name` with the name of your secret. ```shell -gh secret set secret-name +gh secret set SECRET_NAME ``` The CLI will prompt you to enter a secret value. Alternatively, you can read the value of the secret from a file. ```shell -gh secret set secret-name < secret.txt +gh secret set SECRET_NAME < secret.txt ``` To list all secrets for the repository, use the `gh secret list` subcommand. @@ -128,13 +128,13 @@ To list all secrets for the repository, use the `gh secret list` subcommand. To add a secret for an environment, use the `gh secret set` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret set --env environment-name secret-name +gh secret set --env ENV_NAME SECRET_NAME ``` To list all secrets for an environment, use the `gh secret list` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret list --env environment-name +gh secret list --env ENV_NAME ``` {% endcli %} @@ -173,25 +173,25 @@ gh auth login --scopes "admin:org" To add a secret for an organization, use the `gh secret set` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret set --org organization-name secret-name +gh secret set --org ORG_NAME SECRET_NAME ``` By default, the secret is only available to private repositories. To specify that the secret should be available to all repositories within the organization, use the `--visibility` or `-v` flag. ```shell -gh secret set --org organization-name secret-name --visibility all +gh secret set --org ORG_NAME SECRET_NAME --visibility all ``` To specify that the secret should be available to selected repositories within the organization, use the `--repos` or `-r` flag. ```shell -gh secret set --org organization-name secret-name --repos repo-name-1,repo-name-2" +gh secret set --org ORG_NAME SECRET_NAME --repos REPO-NAME-1, REPO-NAME-2" ``` To list all secrets for an organization, use the `gh secret list` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret list --org organization-name +gh secret list --org ORG_NAME ``` {% endcli %} diff --git a/translations/ja-JP/content/actions/using-github-hosted-runners/using-larger-runners.md b/translations/ja-JP/content/actions/using-github-hosted-runners/using-larger-runners.md index 17fb1a7a0f..e3251b78a6 100644 --- a/translations/ja-JP/content/actions/using-github-hosted-runners/using-larger-runners.md +++ b/translations/ja-JP/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -1,11 +1,11 @@ --- title: Using larger runners +shortTitle: 'Larger runners' intro: '{% data variables.product.prodname_dotcom %} offers larger runners with more RAM and CPU.' miniTocMaxHeadingLevel: 3 product: '{% data reusables.gated-features.hosted-runners %}' versions: feature: 'actions-hosted-runners' -shortTitle: Using {% data variables.actions.hosted_runner %}s --- ## Overview of {% data variables.actions.hosted_runner %}s @@ -87,7 +87,7 @@ You can add a {% data variables.actions.hosted_runner %} to an organization, whe ## Running jobs on your runner -Once your runner type has been been defined, you can update your workflows to send jobs to the runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: +Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: ```yaml name: learn-github-actions @@ -104,6 +104,8 @@ jobs: - run: bats -v ``` +To find out which runners are enabled for your repository and organization, you must contact your organization admin. Your organization admin can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. + ## Managing access to your runners {% note %} diff --git a/translations/ja-JP/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md b/translations/ja-JP/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md index 77dd9af5bf..ad1fc32d99 100644 --- a/translations/ja-JP/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md +++ b/translations/ja-JP/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md @@ -1,6 +1,6 @@ --- title: Creating starter workflows for your organization -shortTitle: Creating starter workflows +shortTitle: Create starter workflows intro: Learn how you can create starter workflows to help people in your team add new workflows more easily. redirect_from: - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization diff --git a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md index 432b32ff8a..016cb10829 100644 --- a/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md +++ b/translations/ja-JP/content/actions/using-workflows/reusing-workflows.md @@ -1,6 +1,6 @@ --- title: Reusing workflows -shortTitle: Reusing workflows +shortTitle: Reuse workflows intro: Learn how to avoid duplication when creating a workflow by reusing existing workflows. redirect_from: - /actions/learn-github-actions/reusing-workflows @@ -105,7 +105,7 @@ You can define inputs and secrets, which can be passed from the caller workflow on: workflow_call: inputs: - username: + config-path: required: true type: string secrets: @@ -133,10 +133,10 @@ You can define inputs and secrets, which can be passed from the caller workflow runs-on: ubuntu-latest environment: production steps: - - uses: octo-org/my-action@v1 - with: - username: ${{ inputs.username }} - token: ${{ secrets.envPAT }} + - uses: actions/labeler@v4 + with: + repo-token: ${{ secrets.envPAT }} + configuration-path: ${{ inputs.config-path }} ``` {% endraw %} In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job. @@ -162,7 +162,7 @@ name: Reusable workflow example on: workflow_call: inputs: - username: + config-path: required: true type: string secrets: @@ -170,14 +170,13 @@ on: required: true jobs: - example_job: - name: Pass input and secrets to my-action + triage: runs-on: ubuntu-latest steps: - - uses: octo-org/my-action@v1 - with: - username: ${{ inputs.username }} - token: ${{ secrets.token }} + - uses: actions/labeler@v4 + with: + repo-token: ${{ secrets.token }} + configuration-path: ${{ inputs.config-path }} ``` {% endraw %} @@ -256,7 +255,7 @@ When you call a reusable workflow, you can only use the following keywords in th ### Example caller workflow -This workflow file calls two workflow files. The second of these, `workflow-B.yml` (shown in the [example reusable workflow](#example-reusable-workflow)), is passed an input (`username`) and a secret (`token`). +This workflow file calls two workflow files. The second of these, `workflow-B.yml` (shown in the [example reusable workflow](#example-reusable-workflow)), is passed an input (`config-path`) and a secret (`token`). {% raw %} ```yaml{:copy} @@ -272,11 +271,14 @@ jobs: uses: octo-org/example-repo/.github/workflows/workflow-A.yml@v1 call-workflow-passing-data: + permissions: + contents: read + pull-requests: write uses: octo-org/example-repo/.github/workflows/workflow-B.yml@main with: - username: mona + config-path: .github/labeler.yml secrets: - token: ${{ secrets.TOKEN }} + token: ${{ secrets.GITHUB_TOKEN }} ``` {% endraw %} diff --git a/translations/ja-JP/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md b/translations/ja-JP/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md index 2109206f82..6d56152317 100644 --- a/translations/ja-JP/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md +++ b/translations/ja-JP/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md @@ -1,6 +1,6 @@ --- title: 'Sharing workflows, secrets, and runners with your organization' -shortTitle: Sharing workflows with your organization +shortTitle: Share workflows with your organization intro: 'Learn how you can use organization features to collaborate with your team, by sharing starter workflows, secrets, and self-hosted runners.' redirect_from: - /actions/learn-github-actions/sharing-workflows-with-your-organization diff --git a/translations/ja-JP/content/actions/using-workflows/triggering-a-workflow.md b/translations/ja-JP/content/actions/using-workflows/triggering-a-workflow.md index 9c19cc72ff..c0c7429ee7 100644 --- a/translations/ja-JP/content/actions/using-workflows/triggering-a-workflow.md +++ b/translations/ja-JP/content/actions/using-workflows/triggering-a-workflow.md @@ -1,6 +1,6 @@ --- title: Triggering a workflow -shortTitle: Triggering a workflow +shortTitle: Trigger a workflow intro: 'How to automatically trigger {% data variables.product.prodname_actions %} workflows' versions: fpt: '*' diff --git a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 26c878bfaa..6f6735949d 100644 --- a/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -93,7 +93,7 @@ By default, the rate limit for {% data variables.product.prodname_actions %} is ```shell ghe-config actions-rate-limiting.enabled true - ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE + ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE ``` 1. To disable the rate limit after it's been enabled, run the following command. diff --git a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index 2fabe7244a..590bf709b2 100644 --- a/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -118,7 +118,7 @@ If the upgrade target you're presented with is a feature release instead of a pa {% data reusables.enterprise_installation.download-package %} 4. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg *** verifying upgrade package signature... ``` 5. If a reboot is required for updates for kernel, MySQL, Elasticsearch or other programs, the hotpatch upgrade script notifies you. @@ -170,14 +170,14 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea 5. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg *** verifying upgrade package signature... ``` 6. Confirm that you'd like to continue with the upgrade and restart after the package signature verifies. The new root filesystem writes to the secondary partition and the instance automatically restarts in maintenance mode: ```shell *** applying update... - This package will upgrade your installation to version version-number - Current root partition: /dev/xvda1 [version-number] + This package will upgrade your installation to version VERSION-NUMBER + Current root partition: /dev/xvda1 [VERSION-NUMBER] Target root partition: /dev/xvda2 Proceed with installation? [y/N] ``` diff --git a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index 7f89aef3ee..47804fb2d7 100644 --- a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -1,6 +1,6 @@ --- -title: Enterprise の監査ログのストリーミング -intro: '監査イベントと Git イベントのデータを {% data variables.product.prodname_dotcom %} から外部のデータ管理システムにストリーミングできます。' +title: Streaming the audit log for your enterprise +intro: 'You can stream audit and Git events data from {% data variables.product.prodname_dotcom %} to an external data management system.' miniTocMaxHeadingLevel: 3 versions: feature: audit-log-streaming @@ -15,34 +15,32 @@ redirect_from: - /github/setting-up-and-managing-your-enterprise/managing-organizations-in-your-enterprise-account/streaming-the-audit-logs-for-organizations-in-your-enterprise-account - /admin/user-management/managing-organizations-in-your-enterprise/streaming-the-audit-logs-for-organizations-in-your-enterprise-account permissions: Enterprise owners can configure audit log streaming. -ms.openlocfilehash: 81eb88f760016390a321798589e7994542c9f312 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147710340' --- -{% ifversion ghes %} {% note %} -**注:** {% data variables.product.product_name %} の監査ログ ストリーミングは現在、ベータ版であり、変更される可能性があります。 +{% ifversion ghes %} +{% note %} -{% endnote %} {% endif %} +**Note:** Audit log streaming is currently in beta for {% data variables.product.product_name %} and is subject to change. -## 監査ログのストリーミングについて +{% endnote %} +{% endif %} -知的財産を保護し、組織のコンプライアンスを維持するために、ストリーミングを使用して監査ログ データのコピーを保持し、監視できます。{% data reusables.audit_log.audited-data-list %} +## About audit log streaming -監査ログのストリーミングには、次の利点があります。 +To help protect your intellectual property and maintain compliance for your organization, you can use streaming to keep copies of your audit log data and monitor: +{% data reusables.audit_log.audited-data-list %} -* **データの探索**。 大量のデータに対してクエリを実行するために、推奨されるツールを使用して、ストリーミングされたイベントを調べることができます。 ストリーミングには、Enterprise アカウント全体の監査イベントと Git イベントの両方が含まれます。{% ifversion pause-audit-log-stream %} -* **データの継続性**。 ストリーミングは、最長 7 日間、監査データを失うことなく一時停止できます。{% endif %} -* **データ保有**。 エクスポートされた監査ログと Git イベント データを必要な期間だけ保持できます。 +The benefits of streaming audit data include: -Enterprise 所有者は、ストリームをいつでも設定{% ifversion pause-audit-log-stream %}、一時停止、{% endif %}または削除することができます。 ストリーミングによって、Enterprise 内のすべての Organization に関する監査と Git イベント データがエクスポートされます。 +* **Data exploration**. You can examine streamed events using your preferred tool for querying large quantities of data. The stream contains both audit events and Git events across the entire enterprise account.{% ifversion pause-audit-log-stream %} +* **Data continuity**. You can pause the stream for up to seven days without losing any audit data.{% endif %} +* **Data retention**. You can keep your exported audit logs and Git events data as long as you need to. -## 監査ログのストリーミングの設定 +Enterprise owners can set up{% ifversion pause-audit-log-stream %}, pause,{% endif %} or delete a stream at any time. The stream exports the audit and Git events data for all of the organizations in your enterprise. -プロバイダーの指示に従って、{% data variables.product.product_name %} での監査ログのストリーミングを設定します。 +## Setting up audit log streaming + +You set up the audit log stream on {% data variables.product.product_name %} by following the instructions for your provider. - [Amazon S3](#setting-up-streaming-to-amazon-s3) - [Azure Blob Storage](#setting-up-streaming-to-azure-blob-storage) @@ -51,52 +49,49 @@ Enterprise 所有者は、ストリームをいつでも設定{% ifversion pause - [Google Cloud Storage](#setting-up-streaming-to-google-cloud-storage) - [Splunk](#setting-up-streaming-to-splunk) -### Amazon S3 へのストリーミングの設定 - -{% ifversion streaming-oidc-s3 %}アクセス キーを使用して S3 へのストリーミングを設定したり、OpenID Connect (OIDC) を使用して {% data variables.product.product_name %} に有効期間の長いシークレットを格納するのを回避したりできます。 - -- [アクセス キーを使用して S3 へのストリーミングを設定する](#setting-up-streaming-to-s3-with-access-keys) -- [OpenID Connect を使用して S3 へのストリーミングを設定する](#setting-up-streaming-to-s3-with-openid-connect) -- [OpenID Connect を使用して S3 へのストリーミングを無効にする](#disabling-streaming-to-s3-with-openid-connect) - -#### アクセス キーを使用して S3 へのストリーミングを設定する -{% endif %} - -監査ログを Amazon の S3 エンドポイントにストリーミングするには、バケットとアクセス キーが必要です。 詳しくは、AWS のドキュメント「[Amazon S3 バケットの作成、設定、操作](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html)」をご覧ください。 必ず、バケットへのパブリック アクセスをブロックして監査ログ情報を保護してください。 - -{% data variables.product.prodname_dotcom %} から監査ログのストリーミングを設定するには、次のものが必要です。 -* Amazon S3 バケットの名前 -* AWS アクセス キー ID -* AWS 秘密鍵 - -アクセス キー ID と秘密鍵の作成またはアクセスについては、AWS ドキュメントの「[Understanding and getting your AWS credentials](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html)」 (AWS 資格情報の理解と取得) を参照してください。 - -{% data reusables.enterprise.navigate-to-log-streaming-tab %} {% data reusables.audit_log.streaming-choose-s3 %}{% ifversion streaming-oidc-s3 %} -1. [認証] で **[アクセス キー]** をクリックします。 - - ![Amazon S3 へのストリーミングに関する認証オプションのスクリーンショット](/assets/images/help/enterprises/audit-log-streaming-s3-access-keys.png){% endif %} -1. ストリームの設定を構成します。 - - - [バケット] に、ストリーミング先のバケットの名前を入力します。 たとえば、`auditlog-streaming-test` のようにします。 - - [アクセス キー ID] に、アクセス キーの ID を入力します。 たとえば、`ABCAIOSFODNN7EXAMPLE1` のようにします。 - - [シークレット キー] に、シークレット キーを入力します。 たとえば、`aBcJalrXUtnWXYZ/A1MDENG/zPxRfiCYEXAMPLEKEY` のようにします。 -{% data reusables.audit_log.streaming-check-s3-endpoint %} {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +### Setting up streaming to Amazon S3 {% ifversion streaming-oidc-s3 %} -#### OpenID Connect を使用して S3 へのストリーミングを設定する +You can set up streaming to S3 with access keys or, to avoid storing long-lived secrets in {% data variables.product.product_name %}, with OpenID Connect (OIDC). -{% note %} +- [Setting up streaming to S3 with access keys](#setting-up-streaming-to-s3-with-access-keys) +- [Setting up streaming to S3 with OpenID Connect](#setting-up-streaming-to-s3-with-openid-connect) +- [Disabling streaming to S3 with OpenID Connect](#disabling-streaming-to-s3-with-openid-connect) -**注:** OpenID Connect を使った Amazon S3 へのストリーミングは、現在ベータ版であり、変更される可能性があります。 +#### Setting up streaming to S3 with access keys +{% endif %} -{% endnote %} +To stream audit logs to Amazon's S3 endpoint, you must have a bucket and access keys. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. Make sure to block public access to the bucket to protect your audit log information. -1. AWS では、{% data variables.product.prodname_dotcom %} の OIDC プロバイダーを IAM に追加します。 詳しくは、AWS のドキュメント「[OpenID Connect (OIDC) ID プロバイダーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」をご覧ください。 +To set up audit log streaming from {% data variables.product.prodname_dotcom %} you will need: +* The name of your Amazon S3 bucket +* Your AWS access key ID +* Your AWS secret key - - プロバイダーの URL には、`https://oidc-configuration.audit-log.githubusercontent.com` を使います。 - - [対象者] には、`sts.amazonaws.com` を使います。 -1. バケットを作成し、バケットへのパブリック アクセスをブロックします。 詳しくは、AWS のドキュメント「[Amazon S3 バケットの作成、設定、操作](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html)」をご覧ください。 -1. {% data variables.product.company_short %} によるバケットへの書き込みを許可するポリシーを作成します。 {% data variables.product.prodname_dotcom %} には、次のアクセス許可のみが必要です。 +For information on creating or accessing your access key ID and secret key, see [Understanding and getting your AWS credentials](https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html) in the AWS documentation. + +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +{% data reusables.audit_log.streaming-choose-s3 %}{% ifversion streaming-oidc-s3 %} +1. Under "Authentication", click **Access keys**. + + ![Screenshot of the authentication options for streaming to Amazon S3](/assets/images/help/enterprises/audit-log-streaming-s3-access-keys.png){% endif %} +1. Configure the stream settings. + + - Under "Bucket", type the name of the bucket you want to stream to. For example, `auditlog-streaming-test`. + - Under "Access Key ID", type your access key ID. For example, `ABCAIOSFODNN7EXAMPLE1`. + - Under "Secret Key", type your secret key. For example, `aBcJalrXUtnWXYZ/A1MDENG/zPxRfiCYEXAMPLEKEY`. +{% data reusables.audit_log.streaming-check-s3-endpoint %} +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} + +{% ifversion streaming-oidc-s3 %} +#### Setting up streaming to S3 with OpenID Connect + +1. In AWS, add the {% data variables.product.prodname_dotcom %} OIDC provider to IAM. For more information, see [Creating OpenID Connect (OIDC) identity providers](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) in the AWS documentation. + + - For the provider URL, use `https://oidc-configuration.audit-log.githubusercontent.com`. + - For "Audience", use `sts.amazonaws.com`. +1. Create a bucket, and block public access to the bucket. For more information, see [Creating, configuring, and working with Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/creating-buckets-s3.html) in the AWS documentation. +1. Create a policy that allows {% data variables.product.company_short %} to write to the bucket. {% data variables.product.prodname_dotcom %} requires only the following permissions. ``` { @@ -113,11 +108,11 @@ Enterprise 所有者は、ストリームをいつでも設定{% ifversion pause ] } ``` - 詳しくは、AWS のドキュメント「[IAM ポリシーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html)」をご覧ください。 -1. {% data variables.product.prodname_dotcom %} IdP のロールと信頼ポリシーを構成します。 詳しくは、AWS のドキュメント「[ウェブ ID または OpenID Connect フェデレーション用のロールを作成する (コンソール)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html)」をご覧ください。 + For more information, see [Creating IAM policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the AWS documentation. +1. Configure the role and trust policy for the {% data variables.product.prodname_dotcom %} IdP. For more information, see [Creating a role for web identity or OpenID Connect Federation (console)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-idp_oidc.html) in the AWS documentation. - - 上で作成したアクセス許可ポリシーを追加して、バケットへの書き込みを許可します。 - - 信頼関係を編集して、`sub` フィールドを検証条件に追加し、`ENTERPRISE` を自分の Enterprise の名前に置き換えます。 + - Add the permissions policy you created above to allow writes to the bucket. + - Edit the trust relationship to add the `sub` field to the validation conditions, replacing `ENTERPRISE` with the name of your enterprise. ``` "Condition": { "StringEquals": { @@ -126,209 +121,217 @@ Enterprise 所有者は、ストリームをいつでも設定{% ifversion pause } } ``` - - 作成されたロールの Amazon Resource Name (ARN) を記録しておきます。 -{% data reusables.enterprise.navigate-to-log-streaming-tab %} {% data reusables.audit_log.streaming-choose-s3 %} -1. [認証] の **[OpenID Connect]** をクリックします。 + - Make note of the Amazon Resource Name (ARN) of the created role. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +{% data reusables.audit_log.streaming-choose-s3 %} +1. Under "Authentication", click **OpenID Connect**. - ![Amazon S3 へのストリーミングに関する認証オプションのスクリーンショット](/assets/images/help/enterprises/audit-log-streaming-s3-oidc.png) -1. ストリームの設定を構成します。 + ![Screenshot of the authentication options for streaming to Amazon S3](/assets/images/help/enterprises/audit-log-streaming-s3-oidc.png) +1. Configure the stream settings. - - [バケット] に、ストリーミング先のバケットの名前を入力します。 たとえば、`auditlog-streaming-test` のようにします。 - - [ARN ロール] に、前に記録した ARN ロールを入力します。 たとえば、`arn:aws::iam::1234567890:role/github-audit-log-streaming-role` のようにします。 -{% data reusables.audit_log.streaming-check-s3-endpoint %} {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} + - Under "Bucket", type the name of the bucket you want to stream to. For example, `auditlog-streaming-test`. + - Under "ARN Role" type the ARN role you noted earlier. For example, `arn:aws::iam::1234567890:role/github-audit-log-streaming-role`. +{% data reusables.audit_log.streaming-check-s3-endpoint %} +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -#### OpenID Connect を使用して S3 へのストリーミングを無効にする +#### Disabling streaming to S3 with OpenID Connect -OIDC のセキュリティ脆弱性を検出したなど、何らかの理由で OIDC を使用した S3 へのストリーミングを無効にする場合は、ストリーミングの設定時に AWS で作成した {% data variables.product.prodname_dotcom %} OIDC プロバイダーを削除します。 詳しくは、AWS のドキュメント「[OpenID Connect (OIDC) ID プロバイダーの作成](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html)」をご覧ください。 +If you want to disable streaming to S3 with OIDC for any reason, such as the discovery of a security vulnerability in OIDC, delete the {% data variables.product.prodname_dotcom %} OIDC provider you created in AWS when you set up streaming. For more information, see [Creating OpenID Connect (OIDC) identity providers](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) in the AWS documentation. -その後は、脆弱性が解決されるまで、アクセス キーを使用してストリーミングを設定します。 詳しい情報については、「[アクセス キーを使用して S3 へのストリーミングを設定する](#setting-up-streaming-to-s3-with-access-keys)」を参照してください。 +Then, set up streaming with access keys until the vulnerability is resolved. For more information, see "[Setting up streaming to S3 with access keys](#setting-up-streaming-to-s3-with-access-keys)." {% endif %} -### Azure Blob Storage へのストリーミングの設定 +### Setting up streaming to Azure Blob Storage -{% data variables.product.prodname_dotcom %} でのストリーミングを設定する前に、まず、Microsoft Azure でストレージ アカウントとコンテナーを作成しておく必要があります。 詳細については、Microsoft のドキュメント「[Azure Blob Storage の概要](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction)」を参照してください。 +Before setting up a stream in {% data variables.product.prodname_dotcom %}, you must first have created a storage account and a container in Microsoft Azure. For details, see the Microsoft documentation, "[Introduction to Azure Blob Storage](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction)." -{% data variables.product.prodname_dotcom %} でストリーミングを構成するには、SAS トークンの URL が必要です。 +To configure the stream in {% data variables.product.prodname_dotcom %} you need the URL of a SAS token. -**Microsoft Azure portal** で次の操作を行います。 -1. [ホーム] ページで、 **[ストレージ アカウント]** をクリックします。 -2. 使用するストレージ アカウントの名前をクリックし、 **[コンテナー]** をクリックします。 +**On Microsoft Azure portal**: +1. On the Home page, click **Storage Accounts**. +2. Click the name of the storage account you want to use, then click **Containers**. - ![Azure の [コンテナー] リンク](/assets/images/azure/azure-storage-containers.png) + ![The Containers link in Azure](/assets/images/azure/azure-storage-containers.png) -1. 使用するコンテナーの名前をクリックします。 -1. **[共有アクセス トークン]** をクリックします。 +1. Click the name of the container you want to use. +1. Click **Shared access tokens**. - ![Azure の [共有アクセス トークン] リンク](/assets/images/azure/azure-storage-shared-access-tokens.png) + ![The shared access token link in Azure](/assets/images/azure/azure-storage-shared-access-tokens.png) -1. **[アクセス許可]** ドロップダウン メニューで、`Create` と `Write` のみを許可するようにアクセス許可を変更します。 +1. In the **Permissions** drop-down menu, change the permissions to only allow `Create` and `Write`. - ![[アクセス許可] ドロップダウン メニュー](/assets/images/azure/azure-storage-permissions.png) + ![The permissions drop-down menu](/assets/images/azure/azure-storage-permissions.png) -1. シークレット ローテーション ポリシーに準拠する有効期限を設定します。 -1. **[SAS トークンおよび URL を生成]** をクリックします。 -1. 表示される **BLOB SAS URL** フィールドの値をコピーします。 この URL を {% data variables.product.prodname_dotcom %} で使用します。 +1. Set an expiry date that complies with your secret rotation policy. +1. Click **Generate SAS token and URL**. +1. Copy the value of the **Blob SAS URL** field that's displayed. You will use this URL in {% data variables.product.prodname_dotcom %}. -**{% data variables.product.prodname_dotcom %}** で次の操作を行います。{% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. **[Configure stream]** をクリックし、 **[Azure Blob Storage]** を選択します。 +**On {% data variables.product.prodname_dotcom %}**: +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Click **Configure stream** and select **Azure Blob Storage**. - ![ドロップダウン メニューから [Azure Blob Storage] を選択する](/assets/images/help/enterprises/audit-stream-choice-azureblob.png) + ![Choose Azure Blob Storage from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-azureblob.png) -1. 構成ページで、Azure でコピーした BLOB SAS URL を入力します。 **[Container]** フィールドは、その URL に基づいて自動入力されます。 +1. On the configuration page, enter the blob SAS URL that you copied in Azure. The **Container** field is auto-filled based on the URL. - ![ストリーミングの設定を入力する](/assets/images/help/enterprises/audit-stream-add-azureblob.png) + ![Enter the stream settings](/assets/images/help/enterprises/audit-stream-add-azureblob.png) -1. **[Check endpoint]** をクリックして、{% data variables.product.prodname_dotcom %} で Azure Blob Storage エンドポイントに接続して書き込むことができることを確認します。 +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Blob Storage endpoint. - ![エンドポイントをチェックする](/assets/images/help/enterprises/audit-stream-check.png) + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -### Azure Event Hubs へのストリーミングの設定 +### Setting up streaming to Azure Event Hubs -{% data variables.product.prodname_dotcom %} でのストリーミングを設定する前に、まず、Microsoft Azure でイベント ハブ名前空間が必要です。 次に、その名前空間内にイベント ハブ インスタンスを作成する必要があります。 ストリーミングを設定するときに、このイベント ハブ インスタンスの詳細が必要になります。 詳細については、Microsoft のドキュメント「[クイック スタート:Azure portal を使用したイベント ハブの作成](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create)」を参照してください。 +Before setting up a stream in {% data variables.product.prodname_dotcom %}, you must first have an event hub namespace in Microsoft Azure. Next, you must create an event hub instance within the namespace. You'll need the details of this event hub instance when you set up the stream. For details, see the Microsoft documentation, "[Quickstart: Create an event hub using Azure portal](https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-create)." -イベント ハブに関する 2 つの情報 (インスタント名と接続文字列) が必要です。 +You need two pieces of information about your event hub: its instance name and the connection string. -**Microsoft Azure portal** で次の操作を行います。 -1. 「Event Hubs」を検索します。 +**On Microsoft Azure portal**: +1. Search for "Event Hubs". - ![Azure portal の検索ボックス](/assets/images/azure/azure-resources-search.png ) + ![The Azure portal search box](/assets/images/azure/azure-resources-search.png ) -1. **[Event Hubs]** を選択します。 イベント ハブの名前が一覧表示されます。 +1. Select **Event Hubs**. The names of your event hubs are listed. - ![イベント ハブの一覧](/assets/images/help/enterprises/azure-event-hubs-list.png) + ![A list of event hubs](/assets/images/help/enterprises/azure-event-hubs-list.png) -1. ストリーミング先のイベント ハブの名前をメモします。 -1. 必要なイベント ハブをクリックします。 次に、左側のメニューで、 **[共有アクセスポリシー]** を選択します。 -1. ポリシーの一覧で共有アクセス ポリシーを選択するか、新しいポリシーを作成します。 +1. Make a note of the name of the event hub you want to stream to. +1. Click the required event hub. Then, in the left menu, select **Shared Access Policies**. +1. Select a shared access policy in the list of policies, or create a new policy. - ![共有アクセス ポリシーの一覧](/assets/images/help/enterprises/azure-shared-access-policies.png) + ![A list of shared access policies](/assets/images/help/enterprises/azure-shared-access-policies.png) -1. **[接続文字列 – 主キー]** フィールドの右側にあるボタンをクリックして、接続文字列をコピーします。 +1. Click the button to the right of the **Connection string-primary key** field to copy the connection string. - ![イベント ハブの接続文字列](/assets/images/help/enterprises/azure-connection-string.png) + ![The event hub connection string](/assets/images/help/enterprises/azure-connection-string.png) -**{% data variables.product.prodname_dotcom %}** で次の操作を行います。{% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. **[Configure stream]** をクリックし、 **[Azure Event Hubs]** を選択します。 +**On {% data variables.product.prodname_dotcom %}**: +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Click **Configure stream** and select **Azure Event Hubs**. - ![ドロップダウン メニューから [Azure Events Hubs] を選択する](/assets/images/help/enterprises/audit-stream-choice-azure.png) + ![Choose Azure Events Hub from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-azure.png) -1. 構成ページで、次の項目を入力します。 - * Azure Event Hubs インスタンスの名前。 - * 接続文字列。 +1. On the configuration page, enter: + * The name of the Azure Event Hubs instance. + * The connection string. - ![ストリーミングの設定を入力する](/assets/images/help/enterprises/audit-stream-add-azure.png) + ![Enter the stream settings](/assets/images/help/enterprises/audit-stream-add-azure.png) -1. **[Check endpoint]** をクリックして、{% data variables.product.prodname_dotcom %} で Azure Events Hubs エンドポイントに接続して書き込むことができることを確認します。 +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Azure Events Hub endpoint. - ![エンドポイントをチェックする](/assets/images/help/enterprises/audit-stream-check.png) + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} {% ifversion streaming-datadog %} -### Datadog へのストリーミングの設定 +### Setting up streaming to Datadog -Datadog へのストリーミングを設定するには、Datadog でクライアント トークンまたは API キーを作成し、次に認証用のトークンを使用して {% data variables.product.product_name %} で監査ログ ストリーミングを構成する必要があります。 Datadog でバケットやその他のストレージ コンテナーを作成する必要はありません。 +To set up streaming to Datadog, you must create a client token or an API key in Datadog, then configure audit log streaming in {% data variables.product.product_name %} using the token for authentication. You do not need to create a bucket or other storage container in Datadog. -Datadog へのストリーミングを設定した後は、"github.audit.streaming" でフィルター処理することで自分の監査ログ データを確認できます。 詳しくは、「[ログ管理](https://docs.datadoghq.com/logs/)」を参照してください。 +After you set up streaming to Datadog, you can see your audit log data by filtering by "github.audit.streaming." For more information, see [Log Management](https://docs.datadoghq.com/logs/). -1. まだ Datadog アカウントがない場合は、それを作成します。 -1. Datadog で、クライアント トークンまたは API キーを生成して、 **[キーのコピー]** をクリックします。 詳しくは、Datadog Docs の「[API キーとアプリケーション キー](https://docs.datadoghq.com/account_management/api-app-keys/)」を参照してください。 {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. **[ストリームの構成]** ドロップダウンを選び、 **[Datadog]** をクリックします。 +1. If you don't already have a Datadog account, create one. +1. In Datadog, generate a client token or an API key, then click **Copy key**. For more information, see [API and Application Keys](https://docs.datadoghq.com/account_management/api-app-keys/) in Datadog Docs. +{% data reusables.enterprise.navigate-to-log-streaming-tab %} +1. Select the **Configure stream** dropdown menu and click **Datadog**. - ![[Datadog] が強調表示された [ストリームの構成] ドロップダウン メニューのスクリーンショット](/assets/images/help/enterprises/audit-stream-choice-datadog.png) -1. [トークン] の下に、先ほどコピーしたトークンを貼り付けます。 + ![Screenshot of the "Configure stream" dropdown menu with "Datadog" highlighted](/assets/images/help/enterprises/audit-stream-choice-datadog.png) +1. Under "Token", paste the token you copied earlier. - ![[トークン] フィールドのスクリーンショット](/assets/images/help/enterprises/audit-stream-datadog-token.png) -1. [サイト] ドロップダウン メニューを選び、Datadog サイトをクリックします。 ご利用の Datadog サイトを特定するには、その Datadog の URL を Datadog Docs にある [Datadog サイト](https://docs.datadoghq.com/getting_started/site/) 内のテーブルと比較します。 + ![Screenshot of the "Token" field](/assets/images/help/enterprises/audit-stream-datadog-token.png) +1. Select the "Site" dropdown menu and click your Datadog site. To determine your Datadog site, compare your Datadog URL to the table in [Datadog sites](https://docs.datadoghq.com/getting_started/site/) in Datadog Docs. - ![[サイト] ドロップダウン メニューのスクリーンショット](/assets/images/help/enterprises/audit-stream-datadog-site.png) -1. {% data variables.product.prodname_dotcom %} で Datadog エンドポイントに接続して書き込みができることを確認するには、 **[エンドポイントのチェック]** をクリックします。 + ![Screenshot of the "Site" dropdown menu](/assets/images/help/enterprises/audit-stream-datadog-site.png) +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Datadog endpoint, click **Check endpoint**. - ![エンドポイントをチェックする](/assets/images/help/enterprises/audit-stream-check.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -1. 数分後、Datadog の **[ログ]** タブに監査ログ データが表示されていることを確認します。 監査ログ データが表示されない場合は、トークンとサイトが正しいことを {% data variables.product.prodname_dotcom %} で確認します。 + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} +1. After a few minutes, confirm that audit log data is appearing on the **Logs** tab in Datadog. If audit log data is not appearing, confirm that your token and site are correct in {% data variables.product.prodname_dotcom %}. {% endif %} -### Google Cloud Storage へのストリーミングの設定 +### Setting up streaming to Google Cloud Storage -Google Cloud Storage へのストリーミングを設定するには、適切な資格情報とアクセス許可を使用して、Google Cloud にサービス アカウントを作成し、そのサービス アカウントの資格情報を認証に使用して {% data variables.product.product_name %} での監査ログのストリーミングを構成します。 +To set up streaming to Google Cloud Storage, you must create a service account in Google Cloud with the appropriate credentials and permissions, then configure audit log streaming in {% data variables.product.product_name %} using the service account's credentials for authentication. -1. Google Cloud のサービス アカウントを作成します。 サービス アカウントのアクセス制御または IAM ロールを設定する必要はありません。 詳細については、Google Cloud のドキュメント「[サービス アカウントの作成と管理](https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating)」を参照してください。 -1. サービス アカウントの JSON キーを作成し、キーを安全に格納します。 詳細については、Google Cloud のドキュメント「[サービス アカウント キーの作成と管理](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating)」を参照してください。 -1. バケットをまだ作成していない場合は、作成します。 詳細については、Google Cloud のドキュメント「[ストレージ バケットの作成](https://cloud.google.com/storage/docs/creating-buckets)」を参照してください。 -1. バケットのストレージ オブジェクト作成者のロールをサービス アカウントに付与します。 詳細については、Google Cloud のドキュメント「[クラウド IAM 権限を使用する](https://cloud.google.com/storage/docs/access-control/using-iam-permissions#bucket-add)」を参照してください。 +1. Create a service account for Google Cloud. You do not need to set access controls or IAM roles for the service account. For more information, see [Creating and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating) in the Google Cloud documentation. +1. Create a JSON key for the service account, and store the key securely. For more information, see [Creating and managing service account keys](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating) in the Google Cloud documentation. +1. If you haven't created a bucket yet, create the bucket. For more information, see [Creating storage buckets](https://cloud.google.com/storage/docs/creating-buckets) in the Google Cloud documentation. +1. Give the service account the Storage Object Creator role for the bucket. For more information, see [Using Cloud IAM permissions](https://cloud.google.com/storage/docs/access-control/using-iam-permissions#bucket-add) in the Google Cloud documentation. {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. [Configure stream] ドロップダウン メニューを選択し、 **[Google Cloud Storage]** をクリックします。 +1. Select the Configure stream drop-down menu and click **Google Cloud Storage**. - ![[Configure stream] ドロップダウン メニューのスクリーンショット](/assets/images/help/enterprises/audit-stream-choice-google-cloud-storage.png) + ![Screenshot of the "Configure stream" drop-down menu](/assets/images/help/enterprises/audit-stream-choice-google-cloud-storage.png) -1. [Bucket] で、Google Cloud Storage バケットの名前を入力します。 +1. Under "Bucket", type the name of your Google Cloud Storage bucket. - ![[Bucket] テキスト フィールドのスクリーンショット](/assets/images/help/enterprises/audit-stream-bucket-google-cloud-storage.png) + ![Screenshot of the "Bucket" text field](/assets/images/help/enterprises/audit-stream-bucket-google-cloud-storage.png) -1. [JSON Credentials] で、サービス アカウントの JSON キーのファイルの内容全体を貼り付けます。 +1. Under "JSON Credentials", paste the entire contents of the file for your service account's JSON key. - ![[JSON Credentials] テキスト フィールドのスクリーンショット](/assets/images/help/enterprises/audit-stream-json-credentials-google-cloud-storage.png) + ![Screenshot of the "JSON Credentials" text field](/assets/images/help/enterprises/audit-stream-json-credentials-google-cloud-storage.png) -1. {% data variables.product.prodname_dotcom %} で Google Cloud Storage バケットに接続して書き込めることを確認するには、 **[Check endpoint]** をクリックします。 +1. To verify that {% data variables.product.prodname_dotcom %} can connect and write to the Google Cloud Storage bucket, click **Check endpoint**. - ![[Check endpoint] ボタンのスクリーンショット](/assets/images/help/enterprises/audit-stream-check-endpoint-google-cloud-storage.png) + ![Screenshot of the "Check endpoint" button](/assets/images/help/enterprises/audit-stream-check-endpoint-google-cloud-storage.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} -### Splunk へのストリーミングの設定 +### Setting up streaming to Splunk -監査ログを Splunk の HTTP Event Collector (HEC) エンドポイントにストリーミングするには、エンドポイントが HTTPS 接続を受け入れるように構成されていることを確認する必要があります。 詳細については、Splunk のドキュメント「[Set up and use HTTP Event Collector in Splunk Web](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector)」 (Splunk Web で HTTP Event Collector を設定および作成する) を参照してください。 +To stream audit logs to Splunk's HTTP Event Collector (HEC) endpoint you must make sure that the endpoint is configured to accept HTTPS connections. For more information, see [Set up and use HTTP Event Collector in Splunk Web](https://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector) in the Splunk documentation. {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. **[Configure stream]** をクリックし、 **[Splunk]** を選択します。 +1. Click **Configure stream** and select **Splunk**. - ![ドロップダウン メニューから [Splunk] を選択する](/assets/images/help/enterprises/audit-stream-choice-splunk.png) + ![Choose Splunk from the drop-down menu](/assets/images/help/enterprises/audit-stream-choice-splunk.png) -1. 構成ページで、次の項目を入力します。 - * ストリーミング先のアプリケーションがホストされているドメイン。 +1. On the configuration page, enter: + * The domain on which the application you want to stream to is hosted. - Splunk Cloud を使用している場合、`Domain` は `http-inputs-` である必要があります。ここで、`host` は、Splunk Cloud で使用するドメインです。 (例: `http-inputs-mycompany.splunkcloud.com`)。 + If you are using Splunk Cloud, `Domain` should be `http-inputs-`, where `host` is the domain you use in Splunk Cloud. For example: `http-inputs-mycompany.splunkcloud.com`. - * アプリケーションでデータを受け入れるポート。
+ * The port on which the application accepts data.
- Splunk Cloud を使用していて、ポート構成を変更していない場合、`Port` は `443` である必要があります。 Splunk Cloud の無料試用版を使用している場合、`Port` は `8088` である必要があります。 + If you are using Splunk Cloud, `Port` should be `443` if you haven't changed the port configuration. If you are using the free trial version of Splunk Cloud, `Port` should be `8088`. - * {% data variables.product.prodname_dotcom %} でサードパーティ アプリケーションに対する認証に使用できるトークン。 + * A token that {% data variables.product.prodname_dotcom %} can use to authenticate to the third-party application. - ![ストリーミングの設定を入力する](/assets/images/help/enterprises/audit-stream-add-splunk.png) + ![Enter the stream settings](/assets/images/help/enterprises/audit-stream-add-splunk.png) -1. **[Enable SSL verification]** チェック ボックスはオンのままにします。 +1. Leave the **Enable SSL verification** check box selected. - 監査ログは常に、暗号化されたデータとしてストリーミングされます。ただし、このオプションを選択すると、{% data variables.product.prodname_dotcom %} によって、イベントの配信前に Splunk インスタンスの SSL 証明書が検証されます。 SSL 検証は、イベントが URL エンドポイントに安全に配信されることを保証するために役立ちます。 このオプションの選択をオフにすることはできますが、SSL 検証を有効のままにすることをお勧めします。 -1. **[Check endpoint]** をクリックして、{% data variables.product.prodname_dotcom %} で Splunk エンドポイントに接続して書き込むことができることを確認します。 - ![エンドポイントをチェックする](/assets/images/help/enterprises/audit-stream-check-splunk.png) {% data reusables.enterprise.verify-audit-log-streaming-endpoint %} + Audit logs are always streamed as encrypted data, however, with this option selected, {% data variables.product.prodname_dotcom %} verifies the SSL certificate of your Splunk instance when delivering events. SSL verification helps ensure that events are delivered to your URL endpoint securely. You can clear the selection of this option, but we recommend you leave SSL verification enabled. +1. Click **Check endpoint** to verify that {% data variables.product.prodname_dotcom %} can connect and write to the Splunk endpoint. + ![Check the endpoint](/assets/images/help/enterprises/audit-stream-check-splunk.png) +{% data reusables.enterprise.verify-audit-log-streaming-endpoint %} {% ifversion pause-audit-log-stream %} -## 監査ログのストリーミングの一時停止 +## Pausing audit log streaming -ストリーミングを一時停止すると、監査ログ データを失うことなく、受信側のアプリケーションでメンテナンスを実行できます。 監査ログは、最長 7 日間 {% data variables.product.product_location %} に格納され、ストリーミングの一時停止を解除するとエクスポートされます。 +Pausing the stream allows you to perform maintenance on the receiving application without losing audit data. Audit logs are stored for up to seven days on {% data variables.product.product_location %} and are then exported when you unpause the stream. -{% ifversion streaming-datadog %} Datadog で受け入れるログは過去 18 時間以降のものに限られます。 Datadog エンドポイントへのストリームを 18 時間以上一時停止した場合、ストリーミングを再開した後に Datadog で受け入れられないログが失われるリスクがあります。 +{% ifversion streaming-datadog %} +Datadog only accepts logs from up to 18 hours in the past. If you pause a stream to a Datadog endpoint for more than 18 hours, you risk losing logs that Datadog won't accept after you resume streaming. {% endif %} {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. **[Pause stream]** をクリックします。 +1. Click **Pause stream**. - ![ストリーミングを一時停止する](/assets/images/help/enterprises/audit-stream-pause.png) + ![Pause the stream](/assets/images/help/enterprises/audit-stream-pause.png) -1. 確認メッセージが表示されます。 **[Pause stream]** をクリックして確定します。 +1. A confirmation message is displayed. Click **Pause stream** to confirm. -アプリケーションが、監査ログを再び受信できるようになったら、 **[Resume stream]** をクリックして監査ログのストリーミングを再開します。 +When the application is ready to receive audit logs again, click **Resume stream** to restart streaming audit logs. {% endif %} -## 監査ログのストリーミングの削除 +## Deleting the audit log stream {% data reusables.enterprise.navigate-to-log-streaming-tab %} -1. **[Delete stream]** をクリックします。 +1. Click **Delete stream**. - ![ストリーミングを削除する](/assets/images/help/enterprises/audit-stream-delete.png) + ![Delete the stream](/assets/images/help/enterprises/audit-stream-delete.png) -1. 確認メッセージが表示されます。 **[Delete stream]** をクリックして確定します。 +1. A confirmation message is displayed. Click **Delete stream** to confirm. diff --git a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index fe9cb82ebb..eb7ca4cae4 100644 --- a/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ For more information about the audit log REST API, see "[Enterprise administrati The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination): ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ You can specify multiple search phrases, such as `created` and `actor`, by separ The query below searches for audit log events for pull requests, where the event occurred on or after Jan 1st, 2022 in the `avocado-corp` enterprise, and the action was performed by the `octocat` user: ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 9d0033a39f..92fa29e8a5 100644 --- a/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/translations/ja-JP/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -44,17 +44,19 @@ If you are a site administrator for {% data variables.product.product_location % {%- ifversion ghae %} ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + ``` {%- else %} ```shell - $ ssh-keygen -t ed25519 -C "your_email@example.com" + $ ssh-keygen -t ed25519 -C "your_email@example.com" ``` {% note %} **Note:** If you are using a legacy system that doesn't support the Ed25519 algorithm, use: ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" ``` {% endnote %} @@ -62,14 +64,14 @@ If you are a site administrator for {% data variables.product.product_location % This creates a new SSH key, using the provided email as a label. ```shell - > Generating public/private algorithm key pair. + > Generating public/private ALGORITHM key pair. ``` 3. When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location. {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_algorithm): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_ALGORITHM: [Press enter] ``` {% endmac %} @@ -77,7 +79,7 @@ If you are a site administrator for {% data variables.product.product_location % {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_algorithm):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_ALGORITHM):[Press enter] ``` {% endwindows %} @@ -85,15 +87,15 @@ If you are a site administrator for {% data variables.product.product_location % {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/algorithm): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/ALGORITHM):[Press enter] ``` {% endlinux %} 4. At the prompt, type a secure passphrase. For more information, see ["Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)." ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` ## Adding your SSH key to the ssh-agent @@ -110,7 +112,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav ```shell $ open ~/.ssh/config - > The file /Users/you/.ssh/config does not exist. + > The file /Users/YOU/.ssh/config does not exist. ``` * If the file doesn't exist, create the file. @@ -198,7 +200,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% data reusables.command_line.open_the_multi_os_terminal %} 3. Paste the text below, substituting in the email address for your account on {% data variables.product.product_name %}. ```shell - $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "your_email@example.com" + $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "YOUR_EMAIL" ``` {%- ifversion not ghae %} @@ -217,7 +219,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] ``` {% endmac %} @@ -225,7 +227,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endwindows %} @@ -233,14 +235,14 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endlinux %} 6. When you are prompted to type a passphrase, press **Enter**. ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` 7. Add the SSH key to your account on {% data variables.product.prodname_dotcom %}. For more information, see "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index 1b2fbec54d..91f2e8d064 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -1,7 +1,7 @@ --- -title: Dependabot アラートの通知を構成する +title: Configuring notifications for Dependabot alerts shortTitle: Configure notifications -intro: '{% data variables.product.prodname_dependabot_alerts %} に関する通知の受信方法を最適化する' +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies @@ -19,50 +19,51 @@ topics: - Vulnerabilities - Dependencies - Repositories -ms.openlocfilehash: b8810c27a10302a7873fc61a32189f33855140bb -ms.sourcegitcommit: ac00e2afa6160341c5b258d73539869720b395a4 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/09/2022 -ms.locfileid: '147878560' --- -## {% data variables.product.prodname_dependabot_alerts %} の通知について -{% data variables.product.prodname_dependabot %} でリポジトリ中に脆弱性のある依存関係{% ifversion GH-advisory-db-supports-malware %}またはマルウェア{% endif %}を検出すると、{% data variables.product.prodname_dependabot %} アラートが生成され、そのリポジトリの [Security]\(セキュリティ\) タブに表示されます。 {% data variables.product.product_name %} では、影響を受けるリポジトリのメンテナーに、その通知設定に従って新しいアラートに関する通知が行われます。{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} は、すべてのパブリック リポジトリでデフォルトで有効化されています。 {% data variables.product.prodname_dependabot_alerts %} の場合、デフォルト設定では、特定の脆弱性ごとにグループ化された {% data variables.product.prodname_dependabot_alerts %} をメールで受信します。 +## About notifications for {% data variables.product.prodname_dependabot_alerts %} + +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. {% endif %} -{% ifversion fpt or ghec %}Organization のオーナーの場合は、ワンクリックで Organization 内のすべてのリポジトリに対して {% data variables.product.prodname_dependabot_alerts %} を有効または無効にできます。 また、新しく作成されたリポジトリに対して {% data variables.product.prodname_dependabot_alerts %} を有効にするか無効にするかを設定することもできます。 詳細については、「[Managing security and analysis settings for your organization (組織のセキュリティと分析の設定を管理する)](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)」を参照してください。 +{% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether {% data variables.product.prodname_dependabot_alerts %} will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} -{% ifversion ghes or ghae %}デフォルトでは、Enterprise のオーナーが Enterprise での通知のためのメールを設定していれば、あなたはメールで {% data variables.product.prodname_dependabot_alerts %} を受け取ることになります。 +{% ifversion ghes or ghae %} +By default, if your enterprise owner has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. -Enterprise のオーナーは、通知なしで {% data variables.product.prodname_dependabot_alerts %} を有効にすることもできます。 詳細については、「[エンタープライズでの {% data variables.product.prodname_dependabot %} の有効化](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)」を参照してください。 +Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." {% endif %} -## {% data variables.product.prodname_dependabot_alerts %}の通知設定 +## Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} -{% ifversion fpt or ghes or ghec %}新しい {% data variables.product.prodname_dependabot %} のアラートが検出されると、{% data variables.product.product_name %} によって、通知の設定に従って、リポジトリについて {% data variables.product.prodname_dependabot_alerts %} にアクセスできるすべてのユーザーに通知されます。 あなたがリポジトリを監視しており、セキュリティ アラートまたはリポジトリ上のすべてのアクティビティの通知を有効にしていて、リポジトリを無視していない場合は、アラートが通知されます。 詳細については、「[通知の設定](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)」を参照してください。 +{% ifversion fpt or ghes or ghec %} +When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endif %} -各ページの上部に表示される [Manage notifications] ドロップダウン {% octicon "bell" aria-label="The notifications bell" %} から、自分または Organization の通知設定を構成できます。 詳細については、「[通知の設定](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)」を参照してください。 +You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} +{% data reusables.notifications.vulnerable-dependency-notification-options %} + +{% ifversion update-notification-settings-22 %} +![Screenshot of {% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/dependabot/dependabot-notification-frequency.png){% else %} +![Screenshot of the {% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png){% endif %} - ![{% data variables.product.prodname_dependabot_alerts %} オプション](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% note %} -**注:** {% data variables.product.company_short %} で通知をフィルター処理して、{% data variables.product.prodname_dependabot_alerts %} を表示できます。 詳細については、「[受信トレイからの通知の管理](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)」を参照してください。 +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% data reusables.repositories.security-alerts-x-github-severity %} 詳しくは、[通知の構成](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)に関するページをご覧ください。 +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." -## {% data variables.product.prodname_dependabot_alerts %} の通知によるノイズを軽減する方法 +## How to reduce the noise from notifications for {% data variables.product.prodname_dependabot_alerts %} -{% data variables.product.prodname_dependabot_alerts %}の通知をあまりに多く受け取ることが心配なら、週次のメールダイジェストにオプトインするか、{% data variables.product.prodname_dependabot_alerts %}を有効化したままで通知をオフにすることをおすすめします。 引き続き移動して、リポジトリの [セキュリティ] タブに {% data variables.product.prodname_dependabot_alerts %} を表示することができます。詳しくは、「[{% data variables.product.prodname_dependabot_alerts %}の表示と更新](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)」を参照してください。 +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." -## 参考資料 +## Further reading -- 「[通知の構成](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)」 -- 「[インボックスからの通知を管理する](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)」 +- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" +- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" diff --git a/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 9dcf891257..5bd218b446 100644 --- a/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/ja-JP/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -33,6 +33,12 @@ You must store this file in the `.github` directory of your repository. When you Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)." +{% note %} + +**Note:** You cannot configure {% data variables.product.prodname_dependabot_alerts %} using the *dependabot.yml* file. + +{% endnote %} + The *dependabot.yml* file has two mandatory top-level keys: `version`, and `updates`. You can, optionally, include a top-level `registries` key{% ifversion ghes = 3.5 %} and/or a `enable-beta-ecosystems` key{% endif %}. The file must start with `version: 2`. ## Configuration options for the *dependabot.yml* file diff --git a/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md b/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md index e560122037..b86ed3fe6a 100644 --- a/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md +++ b/translations/ja-JP/content/code-security/getting-started/securing-your-organization.md @@ -116,7 +116,7 @@ For more information, see "[Managing security and analysis settings for your org ## Configuring {% data variables.product.prodname_code_scanning %} -{% data variables.product.prodname_code_scanning_capc %} is an {% data variables.product.prodname_advanced_security %} feature that scans code for security vulnerabilities and errors +{% data variables.product.prodname_code_scanning_capc %} is an {% data variables.product.prodname_advanced_security %} feature that scans code for security vulnerabilities and errors. {% ifversion fpt or ghec %}{% data variables.product.prodname_code_scanning_capc %} is available for all public repositories. Organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %} can additionally use {% data variables.product.prodname_code_scanning %} for private and internal repositories.{% else %}{% data variables.product.prodname_code_scanning_capc %} is available if your enterprise uses {% data variables.product.prodname_advanced_security %}.{% endif %} diff --git a/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md b/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md index 8eb4e002f8..17af4bb2aa 100644 --- a/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md +++ b/translations/ja-JP/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md @@ -42,9 +42,9 @@ While {% data variables.product.prodname_github_codespaces %} provides the benef While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. -## Option 4: Use Remote-Containers and Docker for a local containerized environment +## Option 4: Use the Dev Containers extension and Docker for a local containerized environment -If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. +If your repository has a `devcontainer.json`, consider using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. For more information, see "[Developing inside a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% note %} diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md index fe1dcee67c..2465cfe69e 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md @@ -79,4 +79,4 @@ For more information on deleting a codespace, see "[Deleting a codespace](/codes {% data variables.product.prodname_github_codespaces %} is a cloud-based development environment and requires an internet connection. If you lose connection to the internet while working in a codespace, you will not be able to access your codespace. However, any uncommitted changes will be saved. When you have access to an internet connection again, you can connect to your codespace in the exact same state that it was left in. If you have an unstable internet connection, you should commit and push your changes often. -If you know that you will often be working offline, you can use your `devcontainer.json` file with the ["{% data variables.product.prodname_vscode %} Remote - Containers" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to build and attach to a local development container for your repository. For more information, see [Developing inside a container](https://code.visualstudio.com/docs/remote/containers) in the {% data variables.product.prodname_vscode %} documentation. +If you know that you will often be working offline, you can use your `devcontainer.json` file with the ["Dev Containers" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for {% data variables.product.prodname_vscode_shortname %} to build and attach to a local development container for your repository. For more information, see [Developing inside a container](https://code.visualstudio.com/docs/remote/containers) in the {% data variables.product.prodname_vscode %} documentation. diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md index fe6e0c705e..559ed6dc38 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -73,6 +73,8 @@ Organization owners can specify who can create and use codespaces at the organiz ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + If codespaces for this repository are billable, a message is displayed below the **Create codespace on BRANCH** button telling you who will pay for the codespace. + 1. Create your codespace, either using the default options, or after configuring advanced options: * **Use the default options** @@ -131,12 +133,12 @@ To create a new codespace, use the `gh codespace create` subcommand. gh codespace create ``` -You are prompted to choose a repository, a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available). +You are prompted to choose a repository. If codespaces for this repository are billable, a message is displayed telling you who will pay for the codespace. You are then prompted to choose a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available). Alternatively, you can use flags to specify some or all of the options: ```shell -gh codespace create -r owner/repo -b branch --devcontainer-path path -m machine-type +gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE ``` In this example, replace `owner/repo` with the repository identifier. Replace `branch` with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the `-r` flag without the `b` flag, the codespace is created from the default branch. diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md index eee506d1f6..c5cea6210c 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md @@ -78,7 +78,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por To forward a port use the `gh codespace ports forward` subcommand. Replace `codespace-port:local-port` with the remote and local ports that you want to connect. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports forward codespace-port:local-port +gh codespace ports forward CODESPACE-PORT:LOCAL-PORT ``` For more information about this command, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_codespace_ports_forward). @@ -132,7 +132,7 @@ To change the visibility of a forwarded port, use the `gh codespace ports visibi Replace `codespace-port` with the forwarded port number. Replace `setting` with `private`, `org`, or `public`. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports visibility codespace-port:setting +gh codespace ports visibility CODESPACE-PORT:SETTINGS ``` You can set the visibility for multiple ports with one command. For example: diff --git a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md index 0a582c1557..14283811fc 100644 --- a/translations/ja-JP/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md +++ b/translations/ja-JP/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md @@ -62,7 +62,7 @@ For a complete reference of `gh` commands for {% data variables.product.prodname {% note %} -**Note**: The `-c codespace-name` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. +**Note**: The `-c CODESPACE_NAME` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. {% endnote %} @@ -77,7 +77,7 @@ The list includes the unique name of each codespace, which you can use in other ### Create a new codespace ```shell -gh codespace create -r owner/repository [-b branch] +gh codespace create -r OWNER/REPO_NAME [-b BRANCH] ``` For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." @@ -85,7 +85,7 @@ For more information, see "[Creating a codespace](/codespaces/developing-in-code ### Stop a codespace ```shell -gh codespace stop -c codespace-name +gh codespace stop -c CODESPACE-NAME ``` For more information, see "[Deep dive into {% data variables.product.prodname_github_codespaces %}](/codespaces/getting-started/deep-dive#closing-or-stopping-your-codespace)." @@ -93,7 +93,7 @@ For more information, see "[Deep dive into {% data variables.product.prodname_gi ### Delete a codespace ```shell -gh codespace delete -c codespace-name +gh codespace delete -c CODESPACE-NAME ``` For more information, see "[Deleting a codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)." @@ -103,7 +103,7 @@ For more information, see "[Deleting a codespace](/codespaces/developing-in-code To run commands on the remote codespace machine, from your terminal, you can SSH into the codespace. ```shell -gh codespace ssh -c codespace-name +gh codespace ssh -c CODESPACE-NAME ``` {% data variables.product.prodname_github_codespaces %} copies your GitHub SSH keys into the codespace on creation for a seamless authentication experience. You may be asked to enter the passphrase for your SSH key, after which you will get a command prompt from the remote codespace machine. @@ -113,7 +113,7 @@ If you don't have any SSH keys, follow the instructions in "[Generating a new SS ### Open a codespace in {% data variables.product.prodname_vscode %} ```shell -gh codespace code -c codespace-name +gh codespace code -c CODESPACE-NAME ``` For more information, see "[Using {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code)." @@ -121,13 +121,13 @@ For more information, see "[Using {% data variables.product.prodname_github_code ### Open a codespace in JupyterLab ```shell -gh codespace jupyter -c codespace-name +gh codespace jupyter -c CODESPACE-NAME ``` ### Copy a file to/from a codespace ```shell -gh codespace cp [-r] source(s) destination +gh codespace cp [-r] SOURCE(S) DESTINATION ``` Use the prefix `remote:` on a file or directory name to indicate that it's on the codespace. As with the UNIX `cp` command, the first argument specifies the source and the last specifies the destination. If the destination is a directory, you can specify multiple sources. Use the `-r` (recursive) flag if any of the sources is a directory. @@ -171,7 +171,7 @@ For more information about the `gh codespace cp` command, including additional f You can forward a port on a codespace to a local port. The port remains forwarded as long as the process is running. To stop forwarding the port, press Control+C. ```shell -gh codespace ports forward codespace-port-number:local-port-number -c codespace-name +gh codespace ports forward CODESPACE-PORT_NAME:LOCAL-PORT-NAME -c CODESPACE-NAME ``` To see details of forwarded ports enter `gh codespace ports` and then choose a codespace. @@ -179,13 +179,13 @@ To see details of forwarded ports enter `gh codespace ports` and then choose a c You can set the visibility of a forwarded port. {% data reusables.codespaces.port-visibility-settings %} ```shell -gh codespace ports visibility codespace-port:private|org|public -c codespace-name +gh codespace ports visibility CODESPACE-PORT:private|org|public -c CODESPACE-NAME ``` You can set the visibility for multiple ports with one command. For example: ```shell -gh codespace ports visibility 80:private 3000:public 3306:org -c codespace-name +gh codespace ports visibility 80:private 3000:public 3306:org -c CODESPACE-NAME ``` For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." @@ -195,7 +195,7 @@ For more information, see "[Forwarding ports in your codespace](/codespaces/deve You can see the creation log for a codespace. After entering this command you will be asked to enter the passphrase for your SSH key. ```shell -gh codespace logs -c codespace-name +gh codespace logs -c CODESPACE-NAME ``` For more information about the creation log, see "[{% data variables.product.prodname_github_codespaces %} logs](/codespaces/troubleshooting/github-codespaces-logs#creation-logs)." diff --git a/translations/ja-JP/content/codespaces/overview.md b/translations/ja-JP/content/codespaces/overview.md index 447eb37a35..4c07f6674a 100644 --- a/translations/ja-JP/content/codespaces/overview.md +++ b/translations/ja-JP/content/codespaces/overview.md @@ -41,3 +41,5 @@ You can also personalize aspects of your codespace environment by using a public For information on pricing, storage, and usage for {% data variables.product.prodname_github_codespaces %}, see "[About billing for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)." {% data reusables.codespaces.codespaces-spending-limit-requirement %} For information on how organizations owners and billing managers can manage the spending limit for {% data variables.product.prodname_github_codespaces %} for an organization, see "[Managing spending limits for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-github-codespaces)." + +You can see who will pay for a codespace before you create it. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)." \ No newline at end of file diff --git a/translations/ja-JP/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/translations/ja-JP/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 4ab4dec53c..9c44b43045 100644 --- a/translations/ja-JP/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/translations/ja-JP/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -27,9 +27,7 @@ Before you can configure prebuilds for your project the following must be true: ## Configuring a prebuild -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% octicon "codespaces" aria-label="The Codespaces icon" %} {% data variables.product.prodname_codespaces %}**. +{% data reusables.codespaces.accessing-prebuild-configuration %} 1. In the "Prebuild configuration" section of the page, click **Set up prebuild**. ![The 'Set up prebuilds' button](/assets/images/help/codespaces/prebuilds-set-up.png) @@ -80,6 +78,12 @@ Before you can configure prebuilds for your project the following must be true: ![The prebuild failure notification setting](/assets/images/help/codespaces/prebuilds-failure-notification-setting.png) +1. Optionally, at the bottom of the page, click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) + + In the "Advanced options" section, if you select **Disable prebuild optimization**, codespaces will be created without a prebuild if the latest prebuild workflow has failed or is currently running. For more information, see "[Troubleshooting prebuilds](/codespaces/troubleshooting/troubleshooting-prebuilds#preventing-out-of-date-prebuilds-being-used)." + 1. Click **Create**. {% data reusables.codespaces.prebuilds-permission-authorization %} diff --git a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index bd189eecbe..03f5eefc01 100644 --- a/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/ja-JP/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -126,7 +126,7 @@ You can choose from a list of predefined configurations to create a dev containe Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project. For more information about the definitions of predefined dev containers, see the [`devcontainers/images`](https://github.com/devcontainers/images/tree/main/src) repository. -You can add a predefined dev container configuration either while working in a codespace, or while working on a repository locally. To do this in {% data variables.product.prodname_vscode_shortname %} while you are working locally, and not connected to a codespace, you must have the "Remote - Containers" extension installed and enabled. For more information about this extension, see the [{% data variables.product.prodname_vs_marketplace_shortname %}](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). The following procedure describes the process when you are using a codespace. The steps in {% data variables.product.prodname_vscode_shortname %} when you are not connected to a codespace are very similar. +You can add a predefined dev container configuration either while working in a codespace, or while working on a repository locally. To do this in {% data variables.product.prodname_vscode_shortname %} while you are working locally, and not connected to a codespace, you must have the "Dev Containers" extension installed and enabled. For more information about this extension, see the [{% data variables.product.prodname_vs_marketplace_shortname %}](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). The following procedure describes the process when you are using a codespace. The steps in {% data variables.product.prodname_vscode_shortname %} when you are not connected to a codespace are very similar. {% data reusables.codespaces.command-palette-container %} 1. Click the definition you want to use. diff --git a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index b0d92d091d..e029c962f6 100644 --- a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -30,6 +30,38 @@ If you create a codespace and it does not open: If you still cannot create a codespace for a repository where {% data variables.product.prodname_github_codespaces %} is available, {% data reusables.codespaces.contact-support %} +### Codespace creation fails + +If the creation of a codespace fails, it's likely to be due to a temporary infrastructure issue in the cloud - for example, a problem provisioning a virtual machine for the codespace. A less common reason for failure is if it takes longer than an hour to build the container. In this case, the build is cancelled and codespace creation will fail. + +{% note %} + +**Note:** A codespace that was not successfully created is never going to be usable and should be deleted. For more information, see "[Deleting a codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)." + +{% endnote %} + +If you create a codespace and the creation fails: + +1. Check {% data variables.product.prodname_dotcom %}'s [Status page](https://githubstatus.com) for any active incidents. +1. Go to [your {% data variables.product.prodname_github_codespaces %} page](https://github.com/codespaces), delete the codespace, and create a new codespace. +1. If the container is building, look at the logs that are streaming and make sure the build is not stuck. A container build that takes longer than one hour will be canceled, resulting in a failed creation. + + One common scenario where this could happen is if you have a script running that is prompting for user input and waiting for an answer. If this is the case, remove the interactive prompt so that the build can complete non-interactively. + + {% note %} + + **Note**: To view the logs during a build: + * In the browser, click **View logs.** + + ![Screenshot of the Codespaces web UI with the View logs link emphasized](/assets/images/help/codespaces/web-ui-view-logs.png) + + * In the VS Code desktop application, click **Building codespace** in the "Setting up remote connection" that's displayed. + + ![Screenshot of VS Code with the Building codespace link emphasized](/assets/images/help/codespaces/vs-code-building-codespace.png) + + {% endnote %} +2. If you have a container that takes a long time to build, consider using prebuilds to speed up codespace creations. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." + ## Deleting codespaces The owner of a codespace has full control over it and only they can delete their codespaces. You cannot delete a codespace created by another user. diff --git a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index 7c4b0ca4e8..45f62d023a 100644 --- a/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -65,6 +65,24 @@ If the `devcontainer.json` configuration file for a prebuild configuration is up If the workflow runs for a prebuild configuration are failing, you can temporarily disable the prebuild configuration while you investigate. For more information, see "[Managing prebuilds](/codespaces/prebuilding-your-codespaces/managing-prebuilds#disabling-a-prebuild-configuration)." +### Preventing out-of-date prebuilds being used + +By default, if the latest prebuild workflow has failed, then a previous prebuild for the same combination of repository, branch, and `devcontainer.json` configuration file will be used to create new codespaces. This behavior is called prebuild optimization. + +We recommend keeping prebuild optimization enabled, because it helps ensure that codespaces can still be created quickly if an up-to-date prebuild is not available. However, as a repository administrator, you can disable prebuild optimization if you run into problems with prebuilt codespaces being behind the current state of the branch. If you disable prebuild optimization, codespaces for the relevant combination of repository, branch, and `devcontainer.json` file will be created without a prebuild if the latest prebuild workflow has failed or is currently running. + +{% data reusables.codespaces.accessing-prebuild-configuration %} +1. To the right of the affected prebuild configuration, select the ellipsis (**...**), then click **Edit**. + + ![Screenshot of a list of prebuilds, with "Edit" highlighted](/assets/images/help/codespaces/edit-prebuild-configuration.png) +1. Scroll to the bottom of the "Edit configuration" page and click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) +1. If you're sure you want to disable the default setting, select **Disable prebuild optimization**. + + ![Screenshot of the advanced option section and the "disable prebuild optmization" setting](/assets/images/help/codespaces/disable-prebuild-optimization.png) +1. To save your change, click **Update**. + ## Further reading - "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds)" diff --git a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index e5db07d3e1..17139235ce 100644 --- a/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -1,6 +1,6 @@ --- -title: リポジトリコントリビューターのためのガイドラインを定める -intro: プロジェクトに人々がどのようにコントリビュートするべきかを伝えるガイドラインを作成できます。 +title: Setting guidelines for repository contributors +intro: You can create guidelines to communicate how people should contribute to your project. versions: fpt: '*' ghes: '*' @@ -13,59 +13,56 @@ redirect_from: topics: - Community shortTitle: Contributor guidelines -ms.openlocfilehash: b418c5a3d10f8b8f7572f33b17a9ebfbb3de27d3 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147578789' --- -## コントリビューションガイドラインについて -プロジェクトの共同作成者が適切な作業を行えるように、コントリビューション ガイドラインを含むファイルをプロジェクト リポジトリのルート、`docs`、または `.github` フォルダーに追加できます。 プルリクエストをオープンした場合や Issue を作成した場合、そのファイルへのリンクが表示されます。 コントリビューション ガイドラインへのリンクは、ご自分のリポジトリの `contribute` ページにも表示されます。 `contribute` ページの例については、[github/docs/contribute](https://github.com/github/docs/contribute) を参照してください。 +## About contributing guidelines +To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file. The link to the contributing guidelines also appears on your repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). ![contributing-guidelines](/assets/images/help/pull_requests/contributing-guidelines.png) -リポジトリのオーナーにとって、コントリビューションガイドラインとは、人々がどのようにコントリビュートするべきかを伝える方法です。 +For the repository owner, contribution guidelines are a way to communicate how people should contribute. -コントリビューターにとって、このガイドラインは、上手に構築されたプルリクエストの提出をしたり、有益な Issue をオープンすることの確認に役立ちます。 +For contributors, the guidelines help them verify that they're submitting well-formed pull requests and opening useful issues. -オーナーおよびコントリビューターの双方にとって、コントリビューションガイドラインは、プルリクエストや Issue のリジェクトや再提出の手間を未然に軽減するための有効な手段です。 +For both owners and contributors, contribution guidelines save time and hassle caused by improperly created pull requests or issues that have to be rejected and re-submitted. {% ifversion fpt or ghes or ghec %} -ご自分の組織 {% ifversion fpt or ghes or ghec %} または、個人アカウント {% endif %} 向けに既定のコントリビューション ガイドラインを作成できます。 詳細については、「[既定のコミュニティ正常性ファイルの作成](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)」を参照してください。 +You can create default contribution guidelines for your organization{% ifversion fpt or ghes or ghec %} or personal account{% endif %}. For more information, see "[Creating a default community health file](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% tip %} -**ヒント:** リポジトリの保守担当者は、リポジトリの Issue や pull request のテンプレートを作成して、Issue についての特定のガイドラインを設定できます。 詳細については、「[Issue と pull request テンプレートについて](/articles/about-issue-and-pull-request-templates)」を参照してください。 +**Tip:** Repository maintainers can set specific guidelines for issues by creating an issue or pull request template for the repository. For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." {% endtip %} -## *CONTRIBUTING* ファイルを追加する +## Adding a *CONTRIBUTING* file -{% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. リポジトリのルート `docs` または `.github` のディレクトリにコントリビューション ガイドラインを保存するかどうかを決定します。 そして、ファイル名のフィールドに、ファイルの名前および拡張子を入力します。 コントリビューションガイドラインのファイル名では大文字と小文字は区別されません。 サポートされているファイル拡張子の場合、ファイルはリッチテキスト形式でレンダリングされます。 詳細については、「[非コード ファイルでの作業](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)」を参照してください。 - ![新しいファイル名](/assets/images/help/repository/new-file-name.png) - - リポジトリのルート ディレクトリにコントリビューション ガイドラインが表示されるようにするには、「*CONTRIBUTING*」と入力します。 - - リポジトリの `docs` ディレクトリにコントリビューション ガイドラインが表示されるようにするには、「*docs/* 」と入力して新しいディレクトリを作成してから、「*CONTRIBUTING*」を入力します。 - - リポジトリに複数の *CONTRIBUTING* ファイルが含まれている場合、リンクに表示されるファイルは、`.github` ディレクトリ、リポジトリのルート ディレクトリ、最後に `docs` ディレクトリの順に選択されます。 -4. 新しいファイルに、コントリビューションガイドラインを追加します。 このガイドラインには、次のことを含めましょう: - - 有意義な Issue やプルリクエストの作成手順 - - \- 外部ドキュメント、メーリングリストや行動規範へのリンク - - \- コミュニティや行動への期待 -{% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.files.add-file %} +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." + ![New file name](/assets/images/help/repository/new-file-name.png) + - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. + - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. + - If a repository contains more than one *CONTRIBUTING* file, then the file shown in links is chosen from locations in the following order: the `.github` directory, then the repository's root directory, and finally the `docs` directory. +4. In the new file, add contribution guidelines. These could include: + - Steps for creating good issues or pull requests. + - Links to external documentation, mailing lists, or a code of conduct. + - Community and behavioral expectations. +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_new_file %} -## コントリビューションガイドラインの例 +## Examples of contribution guidelines -最初は悩むかもしれませんが、以下のコントリビューションガイドラインの例を役立ててください: +If you're stumped, here are some good examples of contribution guidelines: -- Atom エディターの[コントリビューション ガイドライン](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)。 -- Ruby on Rails の[コントリビューション ガイドライン](https://github.com/rails/rails/blob/main/CONTRIBUTING.md)。 -- Open Government の[コントリビューション ガイドライン](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md)。 +- The {% data variables.product.prodname_docs %} [contribution guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md). +- The Ruby on Rails [contribution guidelines](https://github.com/rails/rails/blob/main/CONTRIBUTING.md). +- The Open Government [contribution guidelines](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md). -## 参考資料 -- オープン ソース ガイドのセクション「[Starting an Open Source Project](https://opensource.guide/starting-a-project/)」(オープン ソース プロジェクトの開始){% ifversion fpt or ghec %} +## Further reading +- The Open Source Guides' section "[Starting an Open Source Project](https://opensource.guide/starting-a-project/)"{% ifversion fpt or ghec %} - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}{% ifversion fpt or ghes or ghec %} -- 「[リポジトリへのライセンスの追加](/articles/adding-a-license-to-a-repository)」{% endif %} +- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)"{% endif %} diff --git a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md index f6d5589692..42d4793a90 100644 --- a/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md +++ b/translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md @@ -1,6 +1,6 @@ --- -title: ブランチでの変更 -intro: '[Atom](https://atom.io/) など、お好きなテキスト エディターを使用して、プロジェクトに変更を加え、{% data variables.product.prodname_desktop %} を使って役に立つコミットを視覚化します。' +title: Making changes in a branch +intro: 'Use your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), to make changes to your project, then use {% data variables.product.prodname_desktop %} to visualize useful commits.' redirect_from: - /desktop/contributing-to-projects/making-changes-in-a-branch versions: @@ -12,11 +12,5 @@ children: - /viewing-the-branch-history - /pushing-changes-to-github shortTitle: Make changes in a branch -ms.openlocfilehash: 3ff1729cdf050f3604c383d965dda117b5a18e42 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/11/2022 -ms.locfileid: '145090142' --- diff --git a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md index 4130690cea..0bda3e62d6 100644 --- a/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md +++ b/translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md @@ -113,7 +113,7 @@ To troubleshoot, sign out of your account on {% data variables.product.prodname_ ### Empty token ```shell -info: [ui] [AppStore.withAuthenticatingUser] account found for repository: node - (empty token) +info: [ui] [AppStore.withAuthenticatingUser] account found for repository: node - USERNAME (empty token) ``` This error means that {% data variables.product.prodname_desktop %} is unable to find the access token that it created in the system keychain. diff --git a/translations/ja-JP/content/developers/overview/managing-deploy-keys.md b/translations/ja-JP/content/developers/overview/managing-deploy-keys.md index 76398425b0..45e840a023 100644 --- a/translations/ja-JP/content/developers/overview/managing-deploy-keys.md +++ b/translations/ja-JP/content/developers/overview/managing-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: デプロイキーの管理 -intro: デプロイメントのスクリプトを自動化する際にサーバー上のSSHキーを管理する様々な方法と、どれが最適な方法かを学んでください。 +title: Managing deploy keys +intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - /guides/managing-deploy-keys - /v3/guides/managing-deploy-keys @@ -14,91 +14,90 @@ versions: ghec: '*' topics: - API -ms.openlocfilehash: 425535eb582c84801d79f00df751bb48d4a5b05e -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146058469' --- -SSHエージェントのフォワーディング、OAuthトークンでのHTTPS、デプロイキー、マシンユーザを使ってデプロイメントスクリプトを自動化する際に、サーバー上のSSHキーを管理できます。 -## SSHエージェントのフォワーディング -多くの場合、特にプロジェクトの開始時には、SSHエージェントのフォワーディングが最も素早くシンプルに使える方法です。 エージェントのフォワーディングでは、ローカルの開発コンピュータで使うのと同じSSHキーを使います。 +You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users. -#### 長所 +## SSH agent forwarding -* 新しいキーを生成したり追跡したりしなくていい。 -* キーの管理は不要。ユーザはローカルと同じ権限をサーバーでも持つ。 -* サーバーにキーは保存されないので、サーバーが侵害を受けた場合でも、侵害されたキーを追跡して削除する必要はない。 +In many cases, especially in the beginning of a project, SSH agent forwarding is the quickest and simplest method to use. Agent forwarding uses the same SSH keys that your local development computer uses. -#### 短所 +#### Pros -* ユーザーは、デプロイに SSH 接続する **必要があります**。自動デプロイ プロセスは使用できません。 -* SSHエージェントのフォワーディングは、Windowsのユーザが実行するのが面倒。 +* You do not have to generate or keep track of any new keys. +* There is no key management; users have the same permissions on the server that they do locally. +* No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys. -#### セットアップ +#### Cons -1. エージェントのフォワーディングをローカルでオンにしてください。 詳細については、[SSH エージェントの転送に関するガイド][ssh-agent-forwarding]を参照してください。 -2. エージェントフォワーディングを使用するように、デプロイスクリプトを設定してください。 たとえば、bash スクリプトでは、エージェントの転送を有効にすると、次のようになります: `ssh -A serverA 'bash -s' < deploy.sh` +* Users **must** SSH in to deploy; automated deploy processes can't be used. +* SSH agent forwarding can be troublesome to run for Windows users. -## OAuthトークンを使ったHTTPSでのクローニング +#### Setup -SSH キーを使用しない場合は、OAuth トークンで HTTPS を使用できます。 +1. Turn on agent forwarding locally. See [our guide on SSH agent forwarding][ssh-agent-forwarding] for more information. +2. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: +`ssh -A serverA 'bash -s' < deploy.sh` -#### 長所 +## HTTPS cloning with OAuth tokens -* サーバーにアクセスできる人なら、リポジトリをデプロイできる。 -* ユーザはローカルのSSH設定を変更する必要がない。 -* 複数のトークン(ユーザごと)が必要ない。サーバーごとに1つのトークンで十分。 -* トークンはいつでも取り消しできるので、本質的には使い捨てのパスワードにすることができる。 +If you don't want to use SSH keys, you can use HTTPS with OAuth tokens. + +#### Pros + +* Anyone with access to the server can deploy the repository. +* Users don't have to change their local SSH settings. +* Multiple tokens (one for each user) are not needed; one token per server is enough. +* A token can be revoked at any time, turning it essentially into a one-use password. {% ifversion ghes %} -* 新しいトークンの生成は、[OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization) を使用して簡単にスクリプト化できます。 +* Generating new tokens can be easily scripted using [the OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization). {% endif %} -#### 短所 +#### Cons -* トークンを確実に正しいアクセススコープで設定しなければならない。 -* トークンは本質的にはパスワードであり、パスワードと同じように保護しなければならない。 +* You must make sure that you configure your token with the correct access scopes. +* Tokens are essentially passwords, and must be protected the same way. -#### セットアップ +#### Setup -[個人用アクセス トークンの作成に関するガイド](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)を参照してください。 +See [our guide on creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). -## デプロイ キー +## Deploy keys {% data reusables.repositories.deploy-keys %} {% data reusables.repositories.deploy-keys-write-access %} -#### 長所 +#### Pros -* リポジトリとサーバーにアクセスできる人は、誰でもプロジェクトをデプロイできる。 -* ユーザはローカルのSSH設定を変更する必要がない。 -* デプロイ キーは既定では読み取り専用ですが、リポジトリに追加するときに書き込みアクセス権を付与することができます。 +* Anyone with access to the repository and server has the ability to deploy the project. +* Users don't have to change their local SSH settings. +* Deploy keys are read-only by default, but you can give them write access when adding them to a repository. -#### 短所 +#### Cons -* デプロイキーは単一のリポジトリに対するアクセスだけを許可できる。 より複雑なプロジェクトは、同じサーバーからプルする多くのリポジトリを持っていることがある。 -* デプロイキーは通常パスフレーズで保護されていないので、サーバーが侵害されると簡単にキーにアクセスされることになる。 +* Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server. +* Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised. -#### セットアップ +#### Setup -1. サーバーで [`ssh-keygen` 手順を実行][generating-ssh-keys]し、生成された公開キーと秘密 RSA キーのペアを保存する場所を覚えておいてください。 -2. 任意の {% data variables.product.product_name %} ページ上の右上隅にある自分のプロフィール写真をクリックしてから、 **[自分のプロフィール]** をクリックします。 ![プロフィールへのアクセス](/assets/images/profile-page.png) -3. プロフィール ページで、 **[リポジトリ]** をクリックし、リポジトリの名前をクリックします。 ![リポジトリのリンク](/assets/images/repos.png) -4. リポジトリから、 **[設定]** をクリックします。 ![リポジトリ設定](/assets/images/repo-settings.png) -5. サイドバーで、 **[キーのデプロイ]** 、 **[デプロイ キーの追加]** の順にクリックします。 ![デプロイ キーの追加リンク](/assets/images/add-deploy-key.png) -6. タイトルを入力し、公開鍵に貼り付けてください。 ![デプロイキーのページ](/assets/images/deploy-key.png) -7. このキーにリポジトリへの書き込みアクセス権を付与する場合は、 **[書き込みアクセスを許可する]** を選択します。 書き込みアクセス権を持つデプロイキーを使うと、リポジトリにデプロイメントのプッシュができるようになります。 -8. **[キーの追加]** をクリックします。 +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server, and remember where you save the generated public and private rsa key pair. +{% data reusables.profile.navigating-to-profile %} -#### 1つのサーバー上で複数のリポジトリを利用する + ![Navigation to profile](/assets/images/profile-page.png) +1. On your profile page, click **Repositories**, then click the name of your repository. ![Repositories link](/assets/images/repos.png) +2. From your repository, click **Settings**. ![Repository settings](/assets/images/repo-settings.png) +3. In the sidebar, click **Deploy Keys**, then click **Add deploy key**. ![Add Deploy Keys link](/assets/images/add-deploy-key.png) +4. Provide a title, paste in your public key. ![Deploy Key page](/assets/images/deploy-key.png) +5. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. +6. Click **Add key**. -1つのサーバー上で複数のリポジトリを使うなら、それぞれのリポジトリに対して専用のキーペアを生成しなければなりません。 複数のリポジトリでデプロイキーを再利用することはできません。 +#### Using multiple repositories on one server -サーバーの SSH 構成ファイル (通常 `~/.ssh/config`) に、各リポジトリのエイリアス エントリを追加します。 次に例を示します。 +If you use multiple repositories on one server, you will need to generate a dedicated key pair for each one. You can't reuse a deploy key for multiple repositories. + +In the server's SSH configuration file (usually `~/.ssh/config`), add an alias entry for each repository. For example: ```bash Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0 @@ -110,79 +109,79 @@ Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif IdentityFile=/home/user/.ssh/repo-1_deploy_key ``` -* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - リポジトリのエイリアス。 -* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - エイリアスで使用するホスト名を構成します。 -* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - 秘密キーをエイリアスに割り当てます。 +* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - The repository's alias. +* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias. +* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias. -こうすれば、ホスト名のエイリアスを使ってSSHでリポジトリとやりとりできます。この場合、このエイリアスに割り当てられたユニークなデプロイキーが使われます。 次に例を示します。 +You can then use the hostname's alias to interact with the repository using SSH, which will use the unique deploy key assigned to that alias. For example: ```bash $ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-1:OWNER/repo-1.git ``` -## サーバー間トークン +## Server-to-server tokens -サーバーが 1 つ以上の組織にわたるリポジトリにアクセスする必要がある場合、GitHub アプリを使用して必要なアクセスを定義し、その GitHub アプリから _スコープを厳格に設定した_、_サーバー間_ のトークンを生成します。 サーバー対サーバーのトークンは単一または複数のリポジトリをスコープとすることができ、権限を細かく設定できます。 たとえば、リポジトリのコンテンツへの読み取り専用アクセス権を持つトークンを生成できます。 +If your server needs to access repositories across one or more organizations, you can use a GitHub App to define the access you need, and then generate _tightly-scoped_, _server-to-server_ tokens from that GitHub App. The server-to-server tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents. -GitHub Appは{% data variables.product.product_name %}でも主役級の存在なので、サーバー間トークンはあらゆるGitHubユーザから分離され、「サービストークン」に相当します。 さらに、サーバー間トークンには独自のレート制限があり、その制限は実行されるOrganizationの規模に応じて拡大されます。 詳細については、「[{% data variables.product.prodname_github_apps %} のレート制限](/developers/apps/rate-limits-for-github-apps)」を参照してください。 +Since GitHub Apps are a first class actor on {% data variables.product.product_name %}, the server-to-server tokens are decoupled from any GitHub user, which makes them comparable to "service tokens". Additionally, server-to-server tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for {% data variables.product.prodname_github_apps %}](/developers/apps/rate-limits-for-github-apps). -#### 長所 +#### Pros -- 権限設定と有効期限 (1時間、またはAPIで手動で取り消された場合にはそれ以下) が明確に定義された、スコープが厳格なトークン。 -- Organizationの規模に従って拡大する、独自のレート制限。 -- GitHubユーザIDと分離されているため、ライセンスのシート数を消費しない。 -- パスワードが付与されないので、直接サインインされない。 +- Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API). +- Dedicated rate limits that grow with your organization. +- Decoupled from GitHub user identities, so they do not consume any licensed seats. +- Never granted a password, so cannot be directly signed in to. -#### 短所 +#### Cons -- GitHub Appを作成するには追加設定が必要。 -- サーバー間トークンは1時間後に期限切れとなるので、再生成する必要がある (通常はコードを使用して、オンデマンドで行なう)。 +- Additional setup is needed to create the GitHub App. +- Server-to-server tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code. -#### セットアップ +#### Setup -1. GitHub Appをパブリックにするかプライベートにするか決定します。 GitHub AppがOrganization内のリポジトリのみで動作する場合は、プライベートに設定した方がいいでしょう。 -1. リポジトリのコンテンツへの読み取り専用アクセスなど、GitHub Appが必要とする権限を決定します。 -1. Organizationの設定ページからGitHub Appを作成します。 詳細については、「[GitHub アプリの作成](/developers/apps/creating-a-github-app)」を参照してください。 -1. GitHub アプリ `id` をメモします。 -1. GitHub Appの秘密鍵を生成してダウンロードし、安全な方法で保存します。 詳細については、「[秘密キーを生成する](/developers/apps/authenticating-with-github-apps#generating-a-private-key)」を参照してください。 -1. 動作させたいリポジトリにGitHubをインストールします。Organizationの全リポジトリにGitHub Appをインストールしても構いません。 -1. GitHub アプリと、それがアクセスできる組織リポジトリの間の接続を表す `installation_id` を特定します。 各 GitHub アプリと組織のペアには、最大で 1 つの `installation_id` があります。 「[認証されたアプリの組織のインストールを取得する](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app)」を使用してこの `installation_id` を識別できます。 これには、JWT を使用した GitHub アプリとしての認証が必要です。詳細については、「[GitHub アプリとしての認証](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app)」を参照してください。 -1. 「[アプリのインストール アクセス トークンを作成する](/rest/reference/apps#create-an-installation-access-token-for-an-app)」を使用して、対応する REST API エンドポイントを使用してサーバー間トークンを生成します。 これには、JWT を使用した GitHub アプリとしての認証が必要です。詳細については、「[GitHub アプリとしての認証](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app)」と「[インストールとしての認証](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)」を参照してください。 -1. このサーバー間トークンを使用して、REST、GraphQL API、またはGitクライアント経由でリポジトリとやり取りします。 +1. Determine if your GitHub App should be public or private. If your GitHub App will only act on repositories within your organization, you likely want it private. +1. Determine the permissions your GitHub App requires, such as read-only access to repository contents. +1. Create your GitHub App via your organization's settings page. For more information, see [Creating a GitHub App](/developers/apps/creating-a-github-app). +1. Note your GitHub App `id`. +1. Generate and download your GitHub App's private key, and store this safely. For more information, see [Generating a private key](/developers/apps/authenticating-with-github-apps#generating-a-private-key). +1. Install your GitHub App on the repositories it needs to act upon, optionally you may install the GitHub App on all repositories in your organization. +1. Identify the `installation_id` that represents the connection between your GitHub App and the organization repositories it can access. Each GitHub App and organization pair have at most a single `installation_id`. You can identify this `installation_id` via [Get an organization installation for the authenticated app](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). +1. Generate a server-to-server token using the corresponding REST API endpoint, [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app), and [Authenticating as an installation](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). +1. Use this server-to-server token to interact with your repositories, either via the REST or GraphQL APIs, or via a Git client. -## マシンユーザ +## Machine users -サーバーが複数のリポジトリにアクセスする必要がある場合、新しいアカウントを{% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}で作成し、自動化専用に使われるSSHキーを添付できます。 {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}のこのアカウントは人間によって使用されるものではないため、_マシン ユーザー_ と呼ばれます。 マシン ユーザーを個人リポジトリの [コラボレーター][collaborator] (読み取りと書き込みアクセス権の付与)、組織リポジトリの [外部コラボレーター][outside-collaborator] (読み取り、書き込み、または管理者アクセス権の付与)、または自動化する必要があるリポジトリへのアクセス権を持つ [チーム][team] (チームのアクセス許可の付与) として追加できます。 +If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). {% ifversion fpt or ghec %} {% tip %} -**ヒント:** [サービス使用条件][tos]の状態: +**Tip:** Our [terms of service][tos] state: -> *"ボット" またはその他の自動化された手段で "アカウント" を登録することは許可されていません。* +> *Accounts registered by "bots" or other automated methods are not permitted.* -これは、アカウントの生成を自動化することはできないということです。 しかし、プロジェクトやOrganization内でデプロイスクリプトのような自動化タスクのために1つのマシンユーザを作成したいなら、それはまったく素晴らしいことです。 +This means that you cannot automate the creation of accounts. But if you want to create a single machine user for automating tasks such as deploy scripts in your project or organization, that is totally cool. {% endtip %} {% endif %} -#### 長所 +#### Pros -* リポジトリとサーバーにアクセスできる人は、誰でもプロジェクトをデプロイできる。 -* (人間の)ユーザがローカルのSSH設定を変更する必要がない。 -* 複数のキーは必要ない。サーバーごとに1つでよい。 +* Anyone with access to the repository and server has the ability to deploy the project. +* No (human) users need to change their local SSH settings. +* Multiple keys are not needed; one per server is adequate. -#### 短所 +#### Cons -* Organizationだけがマシンユーザをリードオンリーのアクセスにできる。 個人リポジトリは、常にコラボレータの読み書きアクセスを許可する。 -* マシンユーザのキーは、デプロイキーのように、通常パスフレーズで保護されない。 +* Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access. +* Machine user keys, like deploy keys, are usually not protected by a passphrase. -#### セットアップ +#### Setup -1. サーバーで [`ssh-keygen` 手順を実行][generating-ssh-keys]し、公開キーをマシン ユーザー アカウントにアタッチします。 -2. マシンユーザアカウントに自動化したいリポジトリへのアクセスを付与してください。 これを行うには、アカウントを [コラボレーター][collaborator] として、[外部コラボレーター][outside-collaborator] として、または組織内の [チーム][team] に追加します。 +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server and attach the public key to the machine user account. +2. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. [ssh-agent-forwarding]: /guides/using-ssh-agent-forwarding/ [generating-ssh-keys]: /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#generating-a-new-ssh-key @@ -192,5 +191,5 @@ GitHub Appは{% data variables.product.product_name %}でも主役級の存在 [outside-collaborator]: /articles/adding-outside-collaborators-to-repositories-in-your-organization [team]: /articles/adding-organization-members-to-a-team -## 参考資料 -- [通知の構成](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) diff --git a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 5125f03909..cf32263771 100644 --- a/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -106,7 +106,7 @@ Activity related to a branch protection rule. For more information, see "[About - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration +- {% data variables.product.prodname_github_apps %} with **Administration** repository permission ### Webhook payload object @@ -161,7 +161,7 @@ Key | Type | Description - Repository webhooks only receive payloads for the `created` and `completed` event types in a repository - Organization webhooks only receive payloads for the `created` and `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. +- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. ### Webhook payload object @@ -185,7 +185,7 @@ Key | Type | Description - Repository webhooks only receive payloads for the `completed` event types in a repository - Organization webhooks only receive payloads for the `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. +- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. ### Webhook payload object @@ -207,7 +207,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `security_events :read` permission +- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission ### Webhook payload object @@ -229,7 +229,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -273,7 +273,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -302,7 +302,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -345,7 +345,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `deployments` permission +- {% data variables.product.prodname_github_apps %} with **Deployments** permission ### Webhook payload object @@ -370,7 +370,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `deployments` permission +- {% data variables.product.prodname_github_apps %} with **Deployments** permission ### Webhook payload object @@ -401,7 +401,7 @@ Activity related to a discussion. For more information, see the "[Using the Grap - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `discussions` permission +- {% data variables.product.prodname_github_apps %} with **Discussions** permission ### Webhook payload object @@ -427,7 +427,7 @@ Activity related to a comment in a discussion. For more information, see "[Using - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `discussions` permission +- {% data variables.product.prodname_github_apps %} with **Discussions** permission ### Webhook payload object @@ -475,7 +475,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -518,7 +518,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -576,7 +576,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `issues` permission +- {% data variables.product.prodname_github_apps %} with **Issues** permission ### Webhook payload object @@ -599,7 +599,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `issues` permission +- {% data variables.product.prodname_github_apps %} with **Issues** permission ### Webhook payload object @@ -622,7 +622,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -673,7 +673,7 @@ For a detailed description of this payload and the payload for each type of `act - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -695,7 +695,7 @@ For a detailed description of this payload and the payload for each type of `act ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -721,7 +721,7 @@ Activity related to merge groups in a merge queue. The type of activity is speci - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `merge_queues` permission +- {% data variables.product.prodname_github_apps %} with **Merge queues** permission ### Webhook payload object @@ -775,7 +775,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -798,7 +798,7 @@ Key | Type | Description {% ifversion ghes or ghae %} - GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} - Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -824,7 +824,7 @@ Key | Type | Description ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `organization_administration` permission +- {% data variables.product.prodname_github_apps %} with **Administration** organization permission ### Webhook payload object @@ -870,7 +870,7 @@ Activity related to {% data variables.product.prodname_registry %}. {% data reus - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pages` permission +- {% data variables.product.prodname_github_apps %} with **Pages** permission ### Webhook payload object @@ -921,7 +921,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -953,7 +953,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -983,7 +983,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -1020,7 +1020,7 @@ Activity related to items in a {% data variables.projects.project_v2 %}. {% data ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** organization permission ### Webhook payload object @@ -1046,7 +1046,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -1073,7 +1073,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1098,7 +1098,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1120,7 +1120,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1143,7 +1143,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1171,7 +1171,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1215,7 +1215,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1236,7 +1236,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends ### Availability -- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload example @@ -1250,7 +1250,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends - Repository webhooks receive all event types except `deleted` - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission receive all event types except `deleted` +- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted` ### Webhook payload object @@ -1319,7 +1319,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission +- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission ### Webhook payload object @@ -1343,7 +1343,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission +- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission ### Webhook payload object @@ -1366,7 +1366,7 @@ The security advisory dataset also powers the GitHub {% data variables.product.p ### Availability -- {% data variables.product.prodname_github_apps %} with the `security_events` permission +- {% data variables.product.prodname_github_apps %} ### Webhook payload object @@ -1391,7 +1391,7 @@ Activity related to enabling or disabling code security and analysis features fo - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration +- {% data variables.product.prodname_github_apps %} with **Administration** repository permission ### Webhook payload object @@ -1464,7 +1464,7 @@ You can only create a sponsorship webhook on {% data variables.product.prodname_ - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `statuses` permission +- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission ### Webhook payload object @@ -1492,7 +1492,7 @@ Key | Type | Description ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -1523,7 +1523,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -1564,7 +1564,7 @@ The event’s actor is the [user](/rest/reference/users) who starred a repositor - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -1585,7 +1585,7 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS ### Availability -- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1634,7 +1634,7 @@ When a {% data variables.product.prodname_actions %} workflow run is requested o ### Availability -- {% data variables.product.prodname_github_apps %} with the `actions` or `contents` permissions. +- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions ### Webhook payload object diff --git a/translations/ja-JP/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md b/translations/ja-JP/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md index 4371cfa20a..463ad45f8b 100644 --- a/translations/ja-JP/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md +++ b/translations/ja-JP/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md @@ -1,6 +1,6 @@ --- -title: GitHub の機能拡張およびインテグレーション -intro: 'サードパーティアプリケーションの中でシームレスに{% data variables.product.product_name %}リポジトリ内で作業をするために、{% data variables.product.product_name %}機能拡張を使ってください。' +title: GitHub extensions and integrations +intro: 'Use {% data variables.product.product_name %} extensions to work seamlessly in {% data variables.product.product_name %} repositories within third-party applications.' redirect_from: - /articles/about-github-extensions-for-third-party-applications - /articles/github-extensions-and-integrations @@ -10,53 +10,43 @@ versions: fpt: '*' ghec: '*' shortTitle: Extensions & integrations -ms.openlocfilehash: f33ce9b9ae55e523bedff1309f3f2f15202dcf82 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/11/2022 -ms.locfileid: '147884214' --- -## エディタツール +## Editor tools -Atom、Unity、{% data variables.product.prodname_vs %} などのサードパーティ エディター ツール内で、{% data variables.product.product_name %} リポジトリに接続できます。 - -### {% data variables.product.product_name %} for Atom - -{% data variables.product.product_name %} for Atom機能拡張を使うと、Atomエディタからコミット、プッシュ、プル、マージコンフリクトの解決などが行えます。 詳細については、公式の [{% data variables.product.product_name %} for Atom サイト](https://github.atom.io/)を参照してください。 +You can connect to {% data variables.product.product_name %} repositories within third-party editor tools such as Unity and {% data variables.product.prodname_vs %}. ### {% data variables.product.product_name %} for Unity -{% data variables.product.product_name %} for Unityエディタ機能拡張を使うと、オープンソースのゲーム開発プラットフォームであるUnity上で開発を行い、作業内容を{% data variables.product.product_name %}上で見ることができます。 詳細については、公式の Unity エディター拡張機能の[サイト](https://unity.github.com/)または[ドキュメント](https://github.com/github-for-unity/Unity/tree/master/docs)を参照してください。 +With the {% data variables.product.product_name %} for Unity editor extension, you can develop on Unity, the open source game development platform, and see your work on {% data variables.product.product_name %}. For more information, see the official Unity editor extension [site](https://unity.github.com/) or the [documentation](https://github.com/github-for-unity/Unity/tree/master/docs). -### {% data variables.product.prodname_vs %} の {% data variables.product.product_name %} +### {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} -{% data variables.product.prodname_vs %} 拡張機能の {% data variables.product.product_name %} を使用すると、{% data variables.product.prodname_vs %} を離れることなく、{% data variables.product.product_name %} リポジトリで作業できます。 詳しい情報については、公式の {% data variables.product.prodname_vs %} 拡張機能の[サイト](https://visualstudio.github.com/)または[ドキュメント](https://github.com/github/VisualStudio/tree/master/docs)を参照してください。 +With the {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} extension, you can work in {% data variables.product.product_name %} repositories without leaving {% data variables.product.prodname_vs %}. For more information, see the official {% data variables.product.prodname_vs %} extension [site](https://visualstudio.github.com/) or [documentation](https://github.com/github/VisualStudio/tree/master/docs). -### {% data variables.product.prodname_vscode %} の {% data variables.product.prodname_dotcom %} +### {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} -{% data variables.product.prodname_vscode %} 拡張機能の {% data variables.product.prodname_dotcom %} を使用すると、{% data variables.product.prodname_vscode_shortname %} で {% data variables.product.product_name %} pull requests を確認および管理できます。 詳しい情報については、公式の {% data variables.product.prodname_vscode_shortname %} 拡張機能の[サイト](https://vscode.github.com/)または[ドキュメント](https://github.com/Microsoft/vscode-pull-request-github)を参照してください。 +With the {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} extension, you can review and manage {% data variables.product.product_name %} pull requests in {% data variables.product.prodname_vscode_shortname %}. For more information, see the official {% data variables.product.prodname_vscode_shortname %} extension [site](https://vscode.github.com/) or [documentation](https://github.com/Microsoft/vscode-pull-request-github). -## プロジェクト管理ツール +## Project management tools -{% data variables.product.product_location %} の個人または Organization アカウントを Jira などのサードパーティのプロジェクト管理ツールと統合できます。 +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party project management tools, such as Jira. -### Jira Cloud と {% data variables.product.product_name %}.com の統合 +### Jira Cloud and {% data variables.product.product_name %}.com integration -Jira Cloud を個人または Organization のアカウントに統合すると、コミットとプルリクエストをスキャンし、メンションされている JIRA の Issue で、関連するメタデータとハイパーリンクを作成できます。 詳細については、マーケットプレースの [Jira 統合アプリ](https://github.com/marketplace/jira-software-github)を参照してください。 +You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace. -## チームコミュニケーションツール +## Team communication tools -{% data variables.product.product_location %} の個人または Organization アカウントを Slack や Microsoft Teams などのサードパーティのコミュニケーション ツールと統合できます。 +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party team communication tools, such as Slack or Microsoft Teams. -### Slack と {% data variables.product.product_name %} の統合 +### Slack and {% data variables.product.product_name %} integration -Slack + {% data variables.product.prodname_dotcom %} アプリを使用すると、リポジトリまたは Organization をサブスクライブし、Issue、pull request、コミット、ディスカッション、リリース、デプロイ レビュー、デプロイの状態に関するリアルタイムの更新を取得できます。 また、Issue を開いたり閉じたりするなどのアクティビティを実行したり、Slack を離れることなく、Issue や pull request に関する詳細な参照を確認することもできます。 また、あなたがチャネルや個人用チャットで受信した {% data variables.product.prodname_dotcom %} 通知の一部でメンションされている場合、このアプリから Slack であなたに直接 ping が実行されます。 +The Slack + {% data variables.product.prodname_dotcom %} app lets you subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, discussions, releases, deployment reviews and deployment statuses. You can also perform activities like opening and closing issues, and you can see detailed references to issues and pull requests without leaving Slack. The app will also ping you personally in Slack if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. -Slack + {% data variables.product.prodname_dotcom %} アプリも [Slack Enterprise Grid](https://slack.com/intl/en-in/help/articles/360000281563-Manage-apps-on-Enterprise-Grid) と互換性があります。 詳細については、マーケットプレースの [Slack + {% data variables.product.prodname_dotcom %} アプリ](https://github.com/marketplace/slack-github)を参照してください。 +The Slack + {% data variables.product.prodname_dotcom %} app is also compatible with [Slack Enterprise Grid](https://slack.com/intl/en-in/help/articles/360000281563-Manage-apps-on-Enterprise-Grid). For more information, visit the [Slack + {% data variables.product.prodname_dotcom %} app](https://github.com/marketplace/slack-github) in the marketplace. -### Microsoft Teams と {% data variables.product.product_name %} の統合 +### Microsoft Teams and {% data variables.product.product_name %} integration -{% data variables.product.prodname_dotcom %} for Teams アプリを使用すると、リポジトリまたは Organization をサブスクライブし、Issue、pull request、コミット、ディスカッション、リリース、デプロイ レビュー、デプロイの状態に関するリアルタイムの更新を取得できます。 また、Issue の開始と終了、Issue や pull request へのコメントなどのアクティビティを実行したり、Microsoft Teams を離れることなく Issue や pull request に関する詳細な参照を確認したりすることができます。 また、あなたがチャネルや個人用チャットで受信した {% data variables.product.prodname_dotcom %} 通知の一部でメンションされている場合、このアプリから Teams であなたに直接 ping が実行されます。 +The {% data variables.product.prodname_dotcom %} for Teams app lets you subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, discussions, releases, deployment reviews and deployment statuses. You can also perform activities like opening and closing issues, commenting on your issues and pull requests, and you can see detailed references to issues and pull requests without leaving Microsoft Teams. The app will also ping you personally in Teams if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. -詳細については、Microsoft AppSource で [{% data variables.product.prodname_dotcom %} for Teams アプリ](https://appsource.microsoft.com/en-us/product/office/WA200002077)を参照してください。 +For more information, visit the [{% data variables.product.prodname_dotcom %} for Teams app](https://appsource.microsoft.com/en-us/product/office/WA200002077) in Microsoft AppSource. diff --git a/translations/ja-JP/content/get-started/getting-started-with-git/associating-text-editors-with-git.md b/translations/ja-JP/content/get-started/getting-started-with-git/associating-text-editors-with-git.md index 88e5405a82..37d6192f7a 100644 --- a/translations/ja-JP/content/get-started/getting-started-with-git/associating-text-editors-with-git.md +++ b/translations/ja-JP/content/get-started/getting-started-with-git/associating-text-editors-with-git.md @@ -1,6 +1,6 @@ --- -title: Git とのテキストエディタの関連付け -intro: テキストエディタを使って Git でファイルを開いたり編集したりしてください。 +title: Associating text editors with Git +intro: Use a text editor to open and edit your files with Git. redirect_from: - /textmate - /articles/using-textmate-as-your-default-editor @@ -15,48 +15,33 @@ versions: ghae: '*' ghec: '*' shortTitle: Associate text editors -ms.openlocfilehash: 0d02c32ff04d4a5a2a1003464175e866630603f4 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '145148757' --- {% mac %} -## エディタとして Atom を使う +## Using {% data variables.product.prodname_vscode %} as your editor -1. [Atom](https://atom.io/) をインストールしてください。 詳しい情報については、Atom の「[Atom のインストール](https://flight-manual.atom.io/getting-started/sections/installing-atom/)」のドキュメントを参照してください。 +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## {% data variables.product.prodname_vscode %} をエディターに使う - -1. [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}) をインストールします。 詳しい情報については、{% data variables.product.prodname_vscode_shortname %} のドキュメントの「[{% data variables.product.prodname_vscode_shortname %} の設定](https://code.visualstudio.com/Docs/setup/setup-overview)」をご覧ください。 -{% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## エディタとして Sublime Text を使う +## Using Sublime Text as your editor -1. [Sublime Text](https://www.sublimetext.com/) をインストールします。 詳しい情報については、Sublime Text の「[インストール](https://docs.sublimetext.io/guide/getting-started/installation.html)」のドキュメントを参照してください。 +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 +3. Type this command: ```shell $ git config --global core.editor "subl -n -w" ``` -## エディタとして TextMate を使う +## Using TextMate as your editor -1. [TextMate](https://macromates.com/) をインストールします。 -2. TextMate の `mate` シェル ユーティリティをインストールします。 詳しい情報については、TextMate のドキュメントで「[`mate` と `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)」を参照してください。 +1. Install [TextMate](https://macromates.com/). +2. Install TextMate's `mate` shell utility. For more information, see "[`mate` and `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)" in the TextMate documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -4. 次のコマンドを入力します。 +4. Type this command: ```shell $ git config --global core.editor "mate -w" ``` @@ -64,38 +49,29 @@ ms.locfileid: '145148757' {% windows %} -## エディタとして Atom を使う +## Using {% data variables.product.prodname_vscode %} as your editor -1. [Atom](https://atom.io/) をインストールしてください。 詳しい情報については、Atom の「[Atom のインストール](https://flight-manual.atom.io/getting-started/sections/installing-atom/)」のドキュメントを参照してください。 +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## {% data variables.product.prodname_vscode %} をエディターに使う - -1. [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}) をインストールします。 詳しい情報については、{% data variables.product.prodname_vscode_shortname %} のドキュメントの「[{% data variables.product.prodname_vscode_shortname %} の設定](https://code.visualstudio.com/Docs/setup/setup-overview)」をご覧ください。 -{% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## エディタとして Sublime Text を使う +## Using Sublime Text as your editor -1. [Sublime Text](https://www.sublimetext.com/) をインストールします。 詳しい情報については、Sublime Text の「[インストール](https://docs.sublimetext.io/guide/getting-started/installation.html)」のドキュメントを参照してください。 +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 +3. Type this command: ```shell $ git config --global core.editor "'C:/Program Files (x86)/sublime text 3/subl.exe' -w" ``` -## エディタとして Notepad++ を使う +## Using Notepad++ as your editor -1. https://notepad-plus-plus.org/ Notepad++ をインストールしてください。 詳しい情報については、Notepad++ の「[概要](https://npp-user-manual.org/docs/getting-started/)」のドキュメントを参照してください。 +1. Install Notepad++ from https://notepad-plus-plus.org/. For more information, see "[Getting started](https://npp-user-manual.org/docs/getting-started/)" in the Notepad++ documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 +3. Type this command: ```shell $ git config --global core.editor "'C:/Program Files (x86)/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin" ``` @@ -103,29 +79,20 @@ ms.locfileid: '145148757' {% linux %} -## エディタとして Atom を使う +## Using {% data variables.product.prodname_vscode %} as your editor -1. [Atom](https://atom.io/) をインストールしてください。 詳しい情報については、Atom の「[Atom のインストール](https://flight-manual.atom.io/getting-started/sections/installing-atom/)」のドキュメントを参照してください。 +1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## {% data variables.product.prodname_vscode %} をエディターに使う - -1. [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}) をインストールします。 詳しい情報については、{% data variables.product.prodname_vscode_shortname %} のドキュメントの「[{% data variables.product.prodname_vscode_shortname %} の設定](https://code.visualstudio.com/Docs/setup/setup-overview)」をご覧ください。 -{% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## エディタとして Sublime Text を使う +## Using Sublime Text as your editor -1. [Sublime Text](https://www.sublimetext.com/) をインストールします。 詳しい情報については、Sublime Text の「[インストール](https://docs.sublimetext.io/guide/getting-started/installation.html)」のドキュメントを参照してください。 +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. 次のコマンドを入力します。 +3. Type this command: ```shell $ git config --global core.editor "subl -n -w" ``` diff --git a/translations/ja-JP/content/get-started/index.md b/translations/ja-JP/content/get-started/index.md index 50f1d6747d..3271be624d 100644 --- a/translations/ja-JP/content/get-started/index.md +++ b/translations/ja-JP/content/get-started/index.md @@ -32,6 +32,7 @@ featuredLinks: - /get-started/onboarding/getting-started-with-github-enterprise-cloud - /get-started/onboarding/getting-started-with-github-enterprise-server - /get-started/onboarding/getting-started-with-github-ae + - /get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github popular: - /github/getting-started-with-github/signing-up-for-a-new-github-account - /get-started/quickstart/hello-world diff --git a/translations/ja-JP/content/get-started/quickstart/communicating-on-github.md b/translations/ja-JP/content/get-started/quickstart/communicating-on-github.md index 1d0f397b3f..746d67c59d 100644 --- a/translations/ja-JP/content/get-started/quickstart/communicating-on-github.md +++ b/translations/ja-JP/content/get-started/quickstart/communicating-on-github.md @@ -1,6 +1,6 @@ --- -title: GitHub でのコミュニケーション -intro: '{% data variables.product.product_name %} 上でさまざまな種類のディスカッションを用い、特定のプロジェクトや変更について、そしてもっと幅広くアイデアや Team のゴールについて話し合うことができます。' +title: Communicating on GitHub +intro: 'You can discuss specific projects and changes, as well as broader ideas or team goals, using different types of discussions on {% data variables.product.product_name %}.' miniTocMaxHeadingLevel: 3 redirect_from: - /github/collaborating-with-issues-and-pull-requests/getting-started/quickstart-for-communicating-on-github @@ -18,137 +18,137 @@ topics: - Issues - Discussions - Fundamentals -ms.openlocfilehash: 6c7461a01cd0bc44bff93b1eb4e8a013d26bc147 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147408892' --- -## はじめに +## Introduction -{% data variables.product.product_name %} には、コミュニティと密接にやり取りできる、コラボレーション可能なコミュニケーション ツールが組み込まれています。 このクイックスタート ガイドでは、ニーズに適したツールの選択方法について説明します。 +{% data variables.product.product_name %} provides built-in collaborative communication tools allowing you to interact closely with your community. This quickstart guide will show you how to pick the right tool for your needs. -{% ifversion discussions %}行いたい会話の種類に応じて、issue、pull request、{% data variables.product.prodname_discussions %}、チーム ディスカッションを作成して参加できます。 -{% else %}行いたい会話の種類に応じて、issue、pull request、チーム ディスカッションを作成して参加できます。 +{% ifversion discussions %} +You can create and participate in issues, pull requests, {% data variables.product.prodname_discussions %}, and team discussions, depending on the type of conversation you'd like to have. +{% else %} +You can create and participate in issues, pull requests and team discussions, depending on the type of conversation you'd like to have. {% endif %} ### {% data variables.product.prodname_github_issues %} -- バグ報告や改善計画、フィードバックなど、プロジェクトの特定の詳細についてのディスカッションに役立ちます。 -- リポジトリに固有であり、通常は明確なオーナーがいます。 -- 多くの場合、{% data variables.product.prodname_dotcom %} のバグ追跡システムと呼ばれます。 +- are useful for discussing specific details of a project such as bug reports, planned improvements and feedback. +- are specific to a repository, and usually have a clear owner. +- are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system. -### Pull Request -- 特定の変更を提案できます。 -- 他のユーザーが提案した変更について直接コメントできます。 -- リポジトリに固有です。 +### Pull requests +- allow you to propose specific changes. +- allow you to comment directly on proposed changes suggested by others. +- are specific to a repository. {% ifversion fpt or ghec %} ### {% data variables.product.prodname_discussions %} -- フォーラムのようなもので、コラボレーションが重要なオープン形式のアイデアやディスカッションに最適です。 -- 多数のリポジトリにまたがる場合があります。 -- コードベースの外部でコラボレーション エクスペリエンスを提供し、アイデアのブレーンストーミングとコミュニティのナレッジ ベースの作成を可能にします。 -- 多くの場合、明確なオーナーはいません。 -- 多くの場合、操作可能なタスクは発生しません。 +- are like a forum, and are best used for open-form ideas and discussions where collaboration is important. +- may span many repositories. +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base. +- often don’t have a clear owner. +- often do not result in an actionable task. {% endif %} -### Team ディスカッション -- プロジェクトをまたぎ、特定の issue または pull request に属していない会話に対して、チームのページで開始できます。 アイデアについてディスカッションするためにリポジトリでIssueを開く代わりに、Teamディスカッションで会話することでTeam全体を巻き込めます。 -- 計画、分析、設計、ユーザー調査、一般的なプロジェクトの意思決定に関するチームのディスカッションを 1 か所で行うことができます。{% ifversion ghes or ghae %} -- コードベースの外部でコラボレーション エクスペリエンスを提供し、アイデアのブレーンストーミングを可能にします。 -- 多くの場合、明確なオーナーはいません。 -- 多くの場合、操作可能なタスクは発生しません。{% endif %} +### Team discussions +- can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion. +- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes or ghae %} +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas. +- often don’t have a clear owner. +- often do not result in an actionable task.{% endif %} -## どのディスカッション ツールを使用すべきか +## Which discussion tool should I use? -### issue のシナリオ +### Scenarios for issues -- タスク、機能強化、バグを追跡したい。 -- バグ報告を提出したい。 -- 特定の機能に関するフィードバックを共有したい。 -- リポジトリ内のファイルについて質問したい。 +- I want to keep track of tasks, enhancements and bugs. +- I want to file a bug report. +- I want to share feedback about a specific feature. +- I want to ask a question about files in the repository. -#### 問題の例 +#### Issue example -この例では、{% data variables.product.prodname_dotcom %} ユーザーがどのようにしてドキュメント オープン ソース リポジトリに issue を作成してバグを認識させ、修正プログラムについて話し合うかを示しています。 +This example illustrates how a {% data variables.product.prodname_dotcom %} user created an issue in our documentation open source repository to make us aware of a bug, and discuss a fix. -![issue の例](/assets/images/help/issues/issue-example.png) +![Example of issue](/assets/images/help/issues/issue-example.png) -- あるユーザーが、中国語版の {% data variables.product.prodname_dotcom %} Docs のページ上部にあるバナーの青い色で、バナー内のテキストが読めなくなることに気付きました。 -- そのユーザーはリポジトリに issue を作成し、問題について述べ、修正プログラム (バナーに別の背景色を使用する) を提案しました。 -- ディスカッションが続き、最終的には、修正プログラムの適用に関する合意に達します。 -- これで、共同作成者が修正プログラムを含む pull request を作成できます。 +- A user noticed that the blue color of the banner at the top of the page in the Chinese version of the {% data variables.product.prodname_dotcom %} Docs makes the text in the banner unreadable. +- The user created an issue in the repository, stating the problem and suggesting a fix (which is, use a different background color for the banner). +- A discussion ensues, and eventually, a consensus will be reached about the fix to apply. +- A contributor can then create a pull request with the fix. -### pull request のシナリオ +### Scenarios for pull requests -- リポジトリの入力ミスを修正したい。 -- リポジトリに変更を加えたい。 -- 変更を加えて issue を修正したい。 -- 他の人によって提案された変更についてコメントしたい。 +- I want to fix a typo in a repository. +- I want to make changes to a repository. +- I want to make changes to fix an issue. +- I want to comment on changes suggested by others. -#### プル要求の例 +#### Pull request example -この例では、{% data variables.product.prodname_dotcom %} ユーザーがどのようにしてドキュメント オープン ソース リポジトリに pull request を作成して入力ミスを修正するかを示します。 +This example illustrates how a {% data variables.product.prodname_dotcom %} user created a pull request in our documentation open source repository to fix a typo. -pull request の **[会話]** タブで、作成者が pull request を作成した理由を説明します。 +In the **Conversation** tab of the pull request, the author explains why they created the pull request. -![pull request の例 - [会話] タブ](/assets/images/help/pull_requests/pr-conversation-example.png) +![Example of pull request - Conversation tab](/assets/images/help/pull_requests/pr-conversation-example.png) -pull request の **[ファイルの変更]** タブには、実装された修正プログラムが表示されます。 +The **Files changed** tab of the pull request shows the implemented fix. -![pull request の例 - [ファイルの変更] タブ](/assets/images/help/pull_requests/pr-files-changed-example.png) +![Example of pull request - Files changed tab](/assets/images/help/pull_requests/pr-files-changed-example.png) -- この共同作成者は、リポジトリの入力ミスに気付きました。 -- このユーザーが、修正プログラムを含む pull request を作成します。 -- リポジトリの保守担当者は、pull request を確認し、それにコメントを付けてマージします。 +- This contributor notices a typo in the repository. +- The user creates a pull request with the fix. +- A repository maintainer reviews the pull request, comments on it, and merges it. {% ifversion discussions %} -### {% data variables.product.prodname_discussions %} のシナリオ +### Scenarios for {% data variables.product.prodname_discussions %} -- リポジトリ内の特定のファイルに必ずしも関連していない質問がある。 -- コラボレーターやチームとニュースを共有したい。 -- 自由回答の会話を開始または参加したい。 -- コミュニティで発表を行いたい。 +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my community. -#### {% data variables.product.prodname_discussions %} の例 +#### {% data variables.product.prodname_discussions %} example -この例では、{% data variables.product.prodname_dotcom %} Docs オープン ソース リポジトリの {% data variables.product.prodname_discussions %} ウェルカム投稿を示し、チームがコミュニティとどのようなコラボレーションを望んでいるかを示しています。 +This example shows the {% data variables.product.prodname_discussions %} welcome post for the {% data variables.product.prodname_dotcom %} Docs open source repository, and illustrates how the team wants to collaborate with their community. -![{% data variables.product.prodname_discussions %} の例](/assets/images/help/discussions/github-discussions-example.png) +![Example of {% data variables.product.prodname_discussions %}](/assets/images/help/discussions/github-discussions-example.png) -このコミュニティ保守担当者は、コミュニティを歓迎し、メンバーに自己紹介を求めるディスカッションを始めました。 この投稿は、訪問者と共同作成者が参加しやすい雰囲気を生み出します。 この投稿では、チームがリポジトリへの投稿を喜んで支援することも明らかになっています。 +This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository. {% endif %} -### チーム ディスカッションのシナリオ +### Scenarios for team discussions -- リポジトリ内の特定のファイルに必ずしも関連していない質問がある。 -- コラボレーターやチームとニュースを共有したい。 -- 自由回答の会話を開始または参加したい。 -- チームで発表を行いたい。 +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my team. -{% ifversion fpt or ghec %} ご覧のように、チーム ディスカッションは {% data variables.product.prodname_discussions %} と非常によく似ています。 {% data variables.product.prodname_dotcom_the_website %} の場合、会話の出発点として {% data variables.product.prodname_discussions %} を使用することをお勧めします。 {% data variables.product.prodname_discussions %} を使用して、{% data variables.product.prodname_dotcom %} 上のどのコミュニティともコラボレーションを行うことができます。 あなたが組織の一員であり、組織内または組織のチーム内で会話を開始したい場合は、チーム ディスカッションを使用する必要があります。 +{% ifversion fpt or ghec %} +As you can see, team discussions are very similar to {% data variables.product.prodname_discussions %}. For {% data variables.product.prodname_dotcom_the_website %}, we recommend using {% data variables.product.prodname_discussions %} as the starting point for conversations. You can use {% data variables.product.prodname_discussions %} to collaborate with any community on {% data variables.product.prodname_dotcom %}. If you are part of an organization, and would like to initiate conversations within your organization or team within that organization, you should use team discussions. {% endif %} -#### チーム ディスカッションの例 +#### Team discussion example -この例は、`octo-team` チームのチーム投稿を示しています。 +This example shows a team post for the `octo-team` team. -![チーム ディスカッションの例](/assets/images/help/projects/team-discussions-example.png) +![Example of team discussion](/assets/images/help/projects/team-discussions-example.png) -`octocat` のチーム メンバーはチーム ディスカッションを投稿し、さまざまなことをチームに通知しました。 -- Mona というチーム メンバーがリモート ゲーム イベントを開始しました。 -- チームが {% data variables.product.prodname_actions %} を使用してどのようにドキュメントを生成するのかを説明するブログ記事があります。 -- April All Hands に関する資料を、すべてのチーム メンバーが閲覧できるようになりました。 +The `octocat` team member posted a team discussion, informing the team of various things: +- A team member called Mona started remote game events. +- There is a blog post describing how the teams use {% data variables.product.prodname_actions %} to produce their docs. +- Material about the April All Hands is now available for all team members to view. -## 次の手順 +## Next steps -これらの例では、{% data variables.product.product_name %} で会話に最適なツールを決定する方法を示しました。 しかし、これは始まりにすぎません。これらのツールをニーズに合わせて調整するためにできることは、他にもたくさんあります。 +These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs. -たとえば、issue の場合は、より迅速に検索できるように issue にラベルをタグ付けしたり、共同作成者が有意義な issue をオープンできるように issue テンプレートを作成したりできます。 詳細については、「[Issue について](/github/managing-your-work-on-github/about-issues#working-with-issues)」と「[Issue と pull request のテンプレートについて](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)」を参照してください。 +For issues, for example, you can tag issues with labels for quicker searching and create issue templates to help contributors open meaningful issues. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues#working-with-issues)" and "[About issue and pull request templates](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." -pull request の場合、提案された変更がまだ進行中の場合は、下書きの pull request を作成できます。 下書きの pull request は、レビュー準備完了としてマークされるまでマージできません。 詳細については、「[pull request について](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)」を参照してください。 +For pull requests, you can create draft pull requests if your proposed changes are still a work in progress. Draft pull requests cannot be merged until they're marked as ready for review. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)." -{% ifversion discussions %}{% data variables.product.prodname_discussions %} の場合は、{% ifversion fpt or ghec %}行動規定を設定し、{% endif %}コミュニティの重要な情報を含むディスカッションをピン留めすることができます。 詳細については、「[ディスカッションについて](/discussions/collaborating-with-your-community-using-discussions/about-discussions)」を参照してください。 +{% ifversion discussions %} +For {% data variables.product.prodname_discussions %}, you can{% ifversion fpt or ghec %} set up a code of conduct and{% endif %} pin discussions that contain important information for your community. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} -チーム ディスカッションの場合は、チームのページでディスカッションを編集または削除したり、チーム ディスカッションの通知を構成したりできます。 詳細については、「[チーム ディスカッションについて](/organizations/collaborating-with-your-team/about-team-discussions)」を参照してください。 +For team discussions, you can edit or delete discussions on a team's page, and you can configure notifications for team discussions. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." + +To learn some advanced formatting features that will help you communicate, see "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)." \ No newline at end of file diff --git a/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md b/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md index 13b2c70a72..a4f544484c 100644 --- a/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md +++ b/translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md @@ -1,12 +1,12 @@ --- -title: Git と GitHub の学習リソース +title: Git and GitHub learning resources redirect_from: - /articles/good-resources-for-learning-git-and-github - /articles/what-are-other-good-resources-for-learning-git-and-github - /articles/git-and-github-learning-resources - /github/getting-started-with-github/git-and-github-learning-resources - /github/getting-started-with-github/quickstart/git-and-github-learning-resources -intro: 'ウェブ上には数多くの役に立つ Git と {% data variables.product.product_name %} のリソースが存在します。 おすすめのものをまとめました。' +intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources on the web. This is a short list of our favorites!' versions: fpt: '*' ghes: '*' @@ -15,55 +15,49 @@ versions: authors: - GitHub shortTitle: Learning resources -ms.openlocfilehash: d8d0457de2842392febee0c90660285e9b1afef8 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146139297' --- -## Git の使用 +## Using Git -[Git の公式プロジェクト サイト](https://git-scm.com)にアクセスし、[ProGit の本](http://git-scm.com/book)を読むことで、Git について理解を深めてください。 [Git コマンド リスト](https://git-scm.com/docs)を確認することもできます。 +Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs). -## {% data variables.product.product_name %}を使用する +## Using {% data variables.product.product_name %} {% ifversion fpt or ghec %} -{% data variables.product.prodname_learning %} では、即座に自動化されたフィードバックやヘルプとともに、{% data variables.product.prodname_dotcom %} に組み込まれた無料のインタラクティブなコースを提供しています。 最初のプルリクエストをオープンしたり、最初のオープンソースへのコントリビューションを行ったり、{% data variables.product.prodname_pages %} のサイトを作成したりできます。 コース オファリングの詳細については、「[{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %})」を参照してください。 +{% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). {% endif %} -[概要](/categories/getting-started-with-github/)に関 する記事を通じて、{% data variables.product.product_name %} について理解を深めることができます。 プロセスの概要については、「[{% data variables.product.prodname_dotcom %} フロー](https://guides.github.com/introduction/flow)」を参照してください。 基本的な概念については、[概要ガイド](https://guides.github.com)を参照してください。 +Become better acquainted with {% data variables.product.product_name %} through our [getting started](/categories/getting-started-with-github/) articles. See our [{% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow) for a process introduction. Refer to our [overview guides](https://guides.github.com) to walk through basic concepts. {% data reusables.support.ask-and-answer-forum %} -### ブランチ、フォーク、プルリクエスト +### Branches, forks, and pull requests -対話型ツールを使用した [Git ブランチ](http://learngitbranching.js.org/)について説明します。 [フォーク](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks)と [pull request](/articles/using-pull-requests)、および {% data variables.product.prodname_dotcom %} での [pull request の使用方法](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github)について説明します。 [コマンド ライン](https://cli.github.com/)から {% data variables.product.prodname_dotcom %} の使用に関するリファレンスにアクセスしてください。 +Learn about [Git branching](http://learngitbranching.js.org/) using an interactive tool. Read about [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) and [pull requests](/articles/using-pull-requests) as well as [how we use pull requests](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) at {% data variables.product.prodname_dotcom %}. Access references about using {% data variables.product.prodname_dotcom %} from the [command line](https://cli.github.com/). -### 動画 +### Tune in -Microsoft の {% data variables.product.prodname_dotcom %} [YouTube のトレーニングとガイドのチャンネル](https://youtube.com/githubguides)では、[pull request](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19)、[フォーク](https://www.youtube.com/watch?v=5oJHRbqEofs)、[リベース](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22)、[リセット](https://www.youtube.com/watch?v=BKPjPMVB81g)機能に関するチュートリアルを提供しています。 各トピックの所要時間は 5 分以内です。 +Our {% data variables.product.prodname_dotcom %} [YouTube Training and Guides channel](https://youtube.com/githubguides) offers tutorials about [pull requests](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [forking](https://www.youtube.com/watch?v=5oJHRbqEofs), [rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22), and [reset](https://www.youtube.com/watch?v=BKPjPMVB81g) functions. Each topic is covered in 5 minutes or less. -## トレーニング +## Training -### 無料コース +### Free courses -{% data variables.product.product_name %} は、[{% data variables.product.prodname_dotcom %} の紹介](https://github.com/skills/introduction-to-github)を含む一連のインタラクティブな[オンデマンド トレーニング コース](https://skills.github.com/)や、{% data variables.product.prodname_actions %} などの {% data variables.product.product_name %} 固有のツールに関するコースを提供しています。 +{% data variables.product.product_name %} offers a series of interactive, [on-demand training courses](https://skills.github.com/) including [Introduction to {% data variables.product.prodname_dotcom %}](https://github.com/skills/introduction-to-github); and courses on {% data variables.product.product_name %} specific tools such as {% data variables.product.prodname_actions %}. -### {% data variables.product.prodname_dotcom %}のウェブベース教育プログラム +### {% data variables.product.prodname_dotcom %}'s web-based educational programs -{% data variables.product.prodname_dotcom %} では、生中継の[トレーニング](https://services.github.com/#upcoming-events)を提供しています。コマンド ラインの好き嫌いにかかわらず、すべてのユーザー向けにハンズオンのプロジェクトベースのアプローチを提供します。 +{% data variables.product.prodname_dotcom %} offers live [trainings](https://services.github.com/#upcoming-events) with a hands-on, project-based approach for those who love the command line and those who don't. -### 企業向けトレーニング +### Training for your company -{% data variables.product.prodname_dotcom %} は、経験豊富な教師が教える[対面式のクラス](https://services.github.com/#offerings)を提供しています。 トレーニング関連の質問がある場合は[お問い合わせください](https://services.github.com/#contact)。 +{% data variables.product.prodname_dotcom %} offers [in-person classes](https://services.github.com/#offerings) taught by our highly-experienced educators. [Contact us](https://services.github.com/#contact) to ask your training-related questions. -## 追加 +## Extras -[Pluralsight](https://www.pluralsight.com/codeschool) のインタラクティブな[オンライン Git コース](https://www.pluralsight.com/courses/code-school-git-real)には、7 つのレベルがあり、楽しいゲーム形式の数十の演習が提供されます。 [.gitignore テンプレート](https://github.com/github/gitignore)をニーズに合わせて自由に調整してください。 +An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) has seven levels with dozens of exercises in a fun game format. Feel free to adapt our [.gitignore templates](https://github.com/github/gitignore) to meet your needs. -{% ifversion fpt or ghec %}integrations{% else %}[integrations](/articles/about-integrations){% endif %} を使用するか、{% data variables.product.prodname_desktop %} と堅牢な [Atom](https://desktop.github.com) テキスト エディターをインストールして、[{% data variables.product.prodname_dotcom %}](https://atom.io) の範囲を拡張します。 +Extend your {% data variables.product.prodname_dotcom %} reach through {% ifversion fpt or ghec %}[integrations](/articles/about-integrations){% else %}integrations{% endif %}, or by installing [{% data variables.product.prodname_desktop %}](https://desktop.github.com) and the robust [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) text editor. -[オープン ソース ガイド](https://opensource.guide/)を使用すると、オープンソース プロジェクトを起動して拡張する方法を確認できます。 +Learn how to launch and grow your open source project with the [Open Source Guides](https://opensource.guide/). diff --git a/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md b/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md index 646a52d76f..ffec457383 100644 --- a/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md +++ b/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md @@ -1,6 +1,6 @@ --- -title: GitHub 上での執筆とフォーマットについて -intro: GitHubは、GitHub Flavored Markdown と呼ばれるテキストフォーマットの構文を、いくつかのユニークな執筆用の機能と組み合わせています。 +title: About writing and formatting on GitHub +intro: GitHub combines a syntax for formatting text called GitHub Flavored Markdown with a few unique writing features. redirect_from: - /articles/about-writing-and-formatting-on-github - /github/writing-on-github/about-writing-and-formatting-on-github @@ -10,40 +10,36 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Write & format on GitHub -ms.openlocfilehash: 7819ebc6bbf3ffa8696c87f82745a19c103c8134 -ms.sourcegitcommit: 478f2931167988096ae6478a257f492ecaa11794 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/09/2022 -ms.locfileid: '147860835' +shortTitle: About writing & formatting --- -[Markdown](http://daringfireball.net/projects/markdown/) は、プレーンテキストを書式設定するための読みやすく、書きやすい構文です。 +[Markdown](http://daringfireball.net/projects/markdown/) is an easy-to-read, easy-to-write syntax for formatting plain text. -サイトで文章とコードをフォーマットするのに使われる {% data variables.product.prodname_dotcom %}Flavored Markdown を作り出すために、弊社ではカスタムの機能をいくつか追加しました。 +We've added some custom functionality to create {% data variables.product.prodname_dotcom %} Flavored Markdown, used to format prose and code across our site. -また、pull request や issue では、[@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)、[issue と PR の参照](/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests)、[絵文字](/articles/basic-writing-and-formatting-syntax/#using-emoji)などの機能を使って他のユーザーとやり取りすることもできます。 +You can also interact with other users in pull requests and issues using features like [@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), [issue and PR references](/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests), and [emoji](/articles/basic-writing-and-formatting-syntax/#using-emoji). -## テキストフォーマット用のツールバー +## Text formatting toolbar -{% data variables.product.product_name %}のすべてのコメントフィールドには、テキストフォーマット用のツールバーが含まれており、Markdown の構文を学ばなくてもテキストをフォーマットできます。 太字や斜体といったスタイルなどの Markdown の書式、ヘッダー、リンク、リストの作成といったことに加えて、このツールバーには @mentions、タスクリスト、issue と pull request へのリンクといった {% data variables.product.product_name %} 固有の機能があります。 +Every comment field on {% data variables.product.product_name %} contains a text formatting toolbar, allowing you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.product_name %}-specific features such as @mentions, task lists, and links to issues and pull requests. {% ifversion fixed-width-font-gfm-fields %} -## エディターで固定幅フォントを有効にする +## Enabling fixed-width fonts in the editor -{% data variables.product.product_name %} のすべてのコメント フィールドで固定幅フォントを有効にすることができます。 固定幅 (等幅) フォントの各文字は同じ水平方向の間隔を占めるため、テーブルやコード スニペットなどの高度な Markdown 構造の編集が簡単にできます。 +You can enable a fixed-width font in every comment field on {% data variables.product.product_name %}. Each character in a fixed-width, or monospace, font occupies the same horizontal space which can make it easier to edit advanced Markdown structures such as tables and code snippets. -![固定幅フォントを有効にした {% data variables.product.product_name %} のコメント フィールドを示すスクリーンショット](/assets/images/help/writing/fixed-width-example.png) +![Screenshot showing the {% data variables.product.product_name %} comment field with fixed-width fonts enabled](/assets/images/help/writing/fixed-width-example.png) -{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.appearance-settings %} -1. [Markdown editor font preference]\(Markdown エディターのフォント設定\) で **[Use a fixed-width (monospace) font when editing Markdown]\(Markdown の編集時に固定幅 (等幅) フォントを使用する\)** を選びます。 - ![{% data variables.product.product_name %} のコメント フィールドで固定幅フォントを有効にしているスクリーンショット](/assets/images/help/writing/enable-fixed-width.png) +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.appearance-settings %} +1. Under "Markdown editor font preference", select **Use a fixed-width (monospace) font when editing Markdown**. + ![Screenshot showing the {% data variables.product.product_name %} comment field with fixed width fonts enabled](/assets/images/help/writing/enable-fixed-width.png) {% endif %} -## 参考資料 +## Further reading -- [{% data variables.product.prodname_dotcom %} Flavored Markdown の仕様](https://github.github.com/gfm/) -- [Basic writing and formatting syntax (基本的な書き方とフォーマットの構文)](/articles/basic-writing-and-formatting-syntax) -- [Working with advanced formatting (高度な書式設定を使った作業)](/articles/working-with-advanced-formatting) +- [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) +- "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)" +- "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)" diff --git a/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index a7321a27c9..b229b71ca3 100644 --- a/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -179,13 +179,7 @@ You can specify the theme an image is displayed for in Markdown by using the HTM For example, the following code displays a sun image for light themes and a moon for dark themes: -```HTML - - - - Shows an illustrated sun in light color mode and a moon with stars in dark color mode. - -``` +{% data reusables.getting-started.picture-element-example %} The old method of specifying images based on the theme, by using a fragment appended to the URL (`#gh-dark-mode-only` or `#gh-light-mode-only`), is deprecated and will be removed in favor of the new method described above. {% endif %} @@ -216,7 +210,7 @@ To order your list, precede each line with a number. You can create a nested list by indenting one or more list items below another item. -To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [Atom](https://atom.io/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (- or *) lies directly below the first character of the text in the item above it. +To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (- or *) lies directly below the first character of the text in the item above it. ```markdown 1. First list item @@ -394,3 +388,4 @@ For more information, see Daring Fireball's "[Markdown Syntax](https://daringfir - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) - "[About writing and formatting on GitHub](/articles/about-writing-and-formatting-on-github)" - "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)" diff --git a/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md b/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md index e2cc9834bb..c5696ffb1b 100644 --- a/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md +++ b/translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md @@ -12,6 +12,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart-for-writing-on-github - /about-writing-and-formatting-on-github - /basic-writing-and-formatting-syntax shortTitle: Start writing on GitHub diff --git a/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 44fc59d190..5e9fa6ecc4 100644 --- a/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/translations/ja-JP/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,8 +70,8 @@ You can find the node ID of an organization project if you know the organization ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -79,8 +79,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION"){ - projectV2(number: NUMBER) { + organization(login: "ORGANIZATION"){ + projectV2(number: NUMBER) { id } } @@ -94,8 +94,8 @@ You can also find the node ID of all projects in your organization. The followin ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{organization(login: \"ORGANIZATION") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -103,7 +103,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION") { + organization(login: "ORGANIZATION") { projectsV2(first: 20) { nodes { id @@ -125,8 +125,8 @@ You can find the node ID of a user project if you know the project number. Repla ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -134,8 +134,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER"){ - projectV2(number: NUMBER) { + user(login: "USER"){ + projectV2(number: NUMBER) { id } } @@ -149,8 +149,8 @@ You can also find the node ID for all of your projects. The following example wi ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -158,7 +158,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER") { + user(login: "USER") { projectsV2(first: 20) { nodes { id @@ -180,8 +180,8 @@ The following example will return the ID, name, settings, and configuration for ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -189,7 +189,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -284,8 +284,8 @@ If you just need the name and ID of a field, and do not need information about i ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -293,7 +293,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -354,8 +354,8 @@ The following example will return the first 20 issues, pull requests, and draft ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -363,7 +363,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { items(first: 20) { nodes{ @@ -446,8 +446,8 @@ The following example will add an issue or pull request to your project. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -455,7 +455,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { + addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { item { id } @@ -488,8 +488,8 @@ The following example will add a draft issue to your project. Replace `PROJECT_I ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: \"PROJECT_ID\" title: \"TITLE\" body: \"BODY\"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -497,7 +497,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { + addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { projectItem { id } @@ -528,8 +528,8 @@ The following example will update your project's settings. Replace `PROJECT_ID` ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: Bearer TOKEN' \ ---data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' +--header 'Authorization: Bearer TOKEN' \ +--data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -539,7 +539,7 @@ gh api graphql -f query=' mutation { updateProjectV2( input: { - projectId: "PROJECT_ID", + projectId: "PROJECT_ID", title: "Project title", public: false, readme: "# Project README\n\nA long description", @@ -565,8 +565,8 @@ The following example will update the value of a text field for an item. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -576,9 +576,9 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { text: "Updated text" } @@ -619,8 +619,8 @@ The following example will update the value of a single select field for an item ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -630,11 +630,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - singleSelectOptionId: "OPTION_ID" + singleSelectOptionId: "OPTION_ID" } } ) { @@ -659,8 +659,8 @@ The following example will update the value of an iteration field for an item. ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -670,11 +670,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - iterationId: "ITERATION_ID" + iterationId: "ITERATION_ID" } } ) { @@ -694,8 +694,8 @@ The following example will delete an item from a project. Replace `PROJECT_ID` w ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} @@ -705,8 +705,8 @@ gh api graphql -f query=' mutation { deleteProjectV2Item( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" } ) { deletedItemId diff --git a/translations/ja-JP/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md b/translations/ja-JP/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md index aae7367309..adbebde7ee 100644 --- a/translations/ja-JP/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/translations/ja-JP/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md @@ -192,7 +192,7 @@ For pull requests, you can also use search to: - Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat` - Filter pull requests by the specific user [requested for review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat`{% ifversion fpt or ghae or ghes > 3.2 or ghec %} - Filter pull requests that someone has asked you directly to review: `state:open type:pr user-review-requested:@me`{% endif %} -- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom` +- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/docs` - Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue` ## Sorting issues and pull requests diff --git a/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index e1c0cc329d..44bb21d747 100644 --- a/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -62,11 +62,11 @@ For more information on Punycodes, see [Internationalized domain name](https://e {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM. IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . + > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -104,19 +104,19 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. - For `A` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t A - > EXAMPLE.COM 3600 IN A 185.199.108.153 - > EXAMPLE.COM 3600 IN A 185.199.109.153 - > EXAMPLE.COM 3600 IN A 185.199.110.153 - > EXAMPLE.COM 3600 IN A 185.199.111.153 + $ dig EXAMPLE.COM +noall +answer -t A + > EXAMPLE.COM 3600 IN A 185.199.108.153 + > EXAMPLE.COM 3600 IN A 185.199.109.153 + > EXAMPLE.COM 3600 IN A 185.199.110.153 + > EXAMPLE.COM 3600 IN A 185.199.111.153 ``` - For `AAAA` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t AAAA - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 + $ dig EXAMPLE.COM +noall +answer -t AAAA + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -132,11 +132,11 @@ After you configure the apex domain, you must configure a CNAME record with your 1. Navigate to your DNS provider and create a `CNAME` record that points `www.example.com` to the default domain for your site: `.github.io` or `.github.io`. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} 2. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER. + > GITHUB-PAGES-SERVER. 22 IN A 192.0.2.1 ``` ## Removing a custom domain diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index 31e01465ba..a53dcfa122 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -1,6 +1,6 @@ --- -title: コマンド ラインを使用してマージ コンフリクトを解決する -intro: コマンド ラインとテキスト エディターを使用することで、マージ コンフリクトを解決できます。 +title: Resolving a merge conflict using the command line +intro: You can resolve merge conflicts using the command line and a text editor. redirect_from: - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line - /articles/resolving-a-merge-conflict-from-the-command-line @@ -15,33 +15,27 @@ versions: topics: - Pull requests shortTitle: Resolve merge conflicts in Git -ms.openlocfilehash: 1d4ff97c2a93d3e5a7aebaa8752810e284203bc1 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/11/2022 -ms.locfileid: '147883458' --- -マージコンフリクトは、競合している変更がファイルの同じ行に行われるとき、またはある人があるファイルを編集し別の人が同じファイルを削除すると発生します。 詳細については、「[マージコンフリクトについて](/articles/about-merge-conflicts/)」を参照してください。 +Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)." {% tip %} -**ヒント:** {% data variables.product.product_name %} のコンフリクト エディターを使用することで、pull request の一部であるブランチの間で競合している行変更のマージ競合を解決できます。 詳細については、「[GitHub でのマージ コンフリクトを解決する](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)」を参照してください。 +**Tip:** You can use the conflict editor on {% data variables.product.product_name %} to resolve competing line change merge conflicts between branches that are part of a pull request. For more information, see "[Resolving a merge conflict on GitHub](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." {% endtip %} -## 競合している行変更のマージ コンフリクト +## Competing line change merge conflicts -競合している行変更により発生するマージ コンフリクトを解決するには、新しいコミットにどの変更を組み込むかをいくつかの別のブランチから選択する必要があります。 +To resolve a merge conflict caused by competing line changes, you must choose which changes to incorporate from the different branches in a new commit. -たとえば、自分と別のユーザーの両方が、同じ Git リポジトリの別のブランチにあるファイル _styleguide.md_ で同じ行を編集した場合、これらのブランチをマージしようとするとマージ競合エラーが発生します。 これらのブランチをマージする前に、新たなコミットでこのマージコンフリクトを解決する必要があります。 +For example, if you and another person both edited the file _styleguide.md_ on the same lines in different branches of the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. マージ コンフリクトが発生しているローカルの Git リポジトリに移動します。 +2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` -3. マージ コンフリクトの影響を受けるファイルのリストを生成します。 この例では、ファイル *styleguide.md* にマージ競合が発生しています。 +3. Generate a list of the files affected by the merge conflict. In this example, the file *styleguide.md* has a merge conflict. ```shell $ git status > # On branch branch-b @@ -55,8 +49,8 @@ ms.locfileid: '147883458' > # > no changes added to commit (use "git add" and/or "git commit -a") ``` -4. [Atom](https://atom.io/) などの適切なテキスト エディターを開き、マージ競合が発生しているファイルに移動します。 -5. ファイル内でマージ競合の先頭を確認するには、ファイルで競合マーカー `<<<<<<<` を検索します。 テキスト エディターでファイルを開くと、行 `<<<<<<< HEAD` の後に HEAD つまりベース ブランチからの変更があることがわかります。 次に、`=======` があります。これは、自分の変更と他のブランチでの変更を区別するものであり、その後に `>>>>>>> BRANCH-NAME` が続きます。 この例では、あるユーザーがベース (HEAD) ブランチに "open an issue" と書き込み、別のユーザーが比較ブランチ (`branch-a`) に "ask your question in IRC" と書き込みました。 +4. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. +5. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`. ``` If you have questions, please @@ -66,34 +60,34 @@ ms.locfileid: '147883458' ask your question in IRC. >>>>>>> branch-a ``` -{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %}この例では、両方の変更が最終的なマージに取り込まれます。 +{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} In this example, both changes are incorporated into the final merge: ```shell If you have questions, please open an issue or ask in our IRC channel if it's more urgent. ``` -7. 変更を追加またはステージングします。 +7. Add or stage your changes. ```shell $ git add . ``` -8. 変更をコメントを付けてコミットします。 +8. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by incorporating both suggestions." ``` -これで、コマンド ラインでブランチをマージできます。または、{% data variables.product.product_name %} で[変更をリモート リポジトリにプッシュ](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)し、pull request で[変更をマージする](/articles/merging-a-pull-request/)ことができます。 +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## 削除したファイルのマージコンフリクト +## Removed file merge conflicts -ある人があるブランチでファイルを削除し、別の人が同じファイルを編集するなどの、ファイルへの変更が競合していることにより発生するマージコンフリクトを解決するには、削除したファイルを削除するか保持するかを新しいコミットで選択する必要があります。 +To resolve a merge conflict caused by competing changes to a file, where a person deletes a file in one branch and another person edits the same file, you must choose whether to delete or keep the removed file in a new commit. -たとえば、自分が *README.md* などのファイルを編集し、別のユーザーが同じ Git リポジトリ内の別のブランチにある同じファイルを削除した場合、これらのブランチをマージしようとするとマージ競合エラーが発生します。 これらのブランチをマージする前に、新たなコミットでこのマージコンフリクトを解決する必要があります。 +For example, if you edited a file, such as *README.md*, and another person removed the same file in another branch in the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. マージ コンフリクトが発生しているローカルの Git リポジトリに移動します。 +2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` -2. マージ コンフリクトの影響を受けるファイルのリストを生成します。 この例では、ファイル *README.md* にマージ競合が発生しています。 +2. Generate a list of the files affected by the merge conflict. In this example, the file *README.md* has a merge conflict. ```shell $ git status > # On branch main @@ -106,32 +100,32 @@ ms.locfileid: '147883458' > # Unmerged paths: > # (use "git add/rm ..." as appropriate to mark resolution) > # - > # deleted by us: README.md + > # deleted by us: README.md > # > # no changes added to commit (use "git add" and/or "git commit -a") ``` -3. [Atom](https://atom.io/) などの適切なテキスト エディターを開き、マージ競合が発生しているファイルに移動します。 -6. 削除したファイルを保存するかどうかを決めます。 削除したファイルに行った最新の変更をテキスト エディターで確認することをお勧めします。 +3. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. +6. Decide if you want keep the removed file. You may want to view the latest changes made to the removed file in your text editor. - 削除したファイルをリポジトリに追加して戻すには: + To add the removed file back to your repository: ```shell $ git add README.md ``` - このファイルをリポジトリから削除するには: + To remove this file from your repository: ```shell $ git rm README.md > README.md: needs merge > rm 'README.md' ``` -7. 変更をコメントを付けてコミットします。 +7. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by keeping README.md file." > [branch-d 6f89e49] Merge branch 'branch-c' into branch-d ``` -これで、コマンド ラインでブランチをマージできます。または、{% data variables.product.product_name %} で[変更をリモート リポジトリにプッシュ](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)し、pull request で[変更をマージする](/articles/merging-a-pull-request/)ことができます。 +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## 参考資料 +## Further reading -- "[マージコンフリクトについて](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" -- "[プル リクエストをローカルでチェックアウトする](/articles/checking-out-pull-requests-locally/)" +- "[About merge conflicts](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" +- "[Checking out pull requests locally](/articles/checking-out-pull-requests-locally/)" diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md index ca86371e9b..a137dad617 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md @@ -83,7 +83,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u To merge a pull request, use the `gh pr merge` subcommand. Replace `pull-request` with the number, URL, or head branch of the pull request. ```shell -gh pr merge pull-request +gh pr merge PULL-REQUEST ``` Follow the interactive prompts to complete the merge. For more information about the merge methods that you can choose, see "[About pull request merges](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md index 6dc332b6d9..0480d3a39c 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -43,11 +43,11 @@ Only the user who created the pull request can give you permission to push commi ``` 5. Type `git clone`, and then paste the URL you copied in Step 3. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY ``` 6. Press **Enter**. Your local clone will be created. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY > Cloning into `FORK-OF-THE-REPOSITORY`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. @@ -61,13 +61,13 @@ Only the user who created the pull request can give you permission to push commi {% endtip %} 7. Navigate into your new cloned repository. ```shell - $ cd FORK-OF-THE-REPOSITORY + $ cd FORK-OF-THE-REPOSITORY ``` 7. Switch branches to the compare branch of the pull request where the original changes were made. If you navigate to the original pull request, you'll see the compare branch at the top of the pull request. ![compare-branch-example](/assets/images/help/pull_requests/compare-branch-example.png) In this example, the compare branch is `test-branch`: ```shell - $ git checkout test-branch + $ git checkout TEST-BRANCH ``` {% tip %} @@ -84,8 +84,8 @@ Only the user who created the pull request can give you permission to push commi > Compressing objects: 100% (26/26), done. > Writing objects: 100% (29/29), 74.94 KiB | 0 bytes/s, done. > Total 29 (delta 8), reused 0 (delta 0) - > To https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY.git - > 12da2e9..250e946 test-branch -> test-branch + > To https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY.git + > 12da2e9..250e946 TEST-BRANCH -> TEST-BRANCH ``` Your new commits will be reflected on the original pull request on {% data variables.product.product_location %}. diff --git a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md index cbfc7e4cab..0740282958 100644 --- a/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md +++ b/translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md @@ -44,7 +44,7 @@ shortTitle: Check out a PR locally To check out a pull request locally, use the `gh pr checkout` subcommand. Replace `pull-request` with the number, URL, or head branch of the pull request. ```shell -gh pr checkout pull-request +gh pr checkout PULL-REQUEST ``` {% endcli %} @@ -64,24 +64,24 @@ Anyone can work with a previously opened pull request to continue working on it, {% data reusables.command_line.open_the_multi_os_terminal %} 5. Fetch the reference to the pull request based on its ID number, creating a new branch in the process. ```shell - $ git fetch origin pull/ID/head:BRANCHNAME + $ git fetch origin pull/ID/head:BRANCH_NAME ``` 6. Switch to the new branch that's based on this pull request: ```shell - [main] $ git checkout BRANCHNAME - > Switched to a new branch 'BRANCHNAME' + [main] $ git checkout BRANCH_NAME + > Switched to a new branch 'BRANCH_NAME' ``` 7. At this point, you can do anything you want with this branch. You can run some local tests, or merge other branches into the branch. 8. When you're ready, you can push the new branch up: ```shell - [pull-inactive-pull-request] $ git push origin BRANCHNAME + [pull-inactive-pull-request] $ git push origin BRANCH_NAME > Counting objects: 32, done. > Delta compression using up to 8 threads. > Compressing objects: 100% (26/26), done. > Writing objects: 100% (29/29), 74.94 KiB | 0 bytes/s, done. > Total 29 (delta 8), reused 0 (delta 0) - > To https://{% data variables.command_line.codeblock %}/username/repository.git - > * [new branch] BRANCHNAME -> BRANCHNAME + > To https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git + > * [new branch] BRANCH_NAME -> BRANCH_NAME ``` 9. [Create a new pull request](/articles/creating-a-pull-request) with your new branch. @@ -90,7 +90,7 @@ Anyone can work with a previously opened pull request to continue working on it, The remote `refs/pull/` namespace is *read-only*. If you try to push any commits there, you'll see this error: ```shell ! [remote rejected] HEAD -> refs/pull/1/head (deny updating a hidden ref) -error: failed to push some refs to 'git@github.local:USERNAME/REPOSITORY.git' +error: failed to push some refs to 'git@github.local:USERNAME/REPOSITORY.git' ``` {% tip %} diff --git a/translations/ja-JP/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md b/translations/ja-JP/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index 75f9b96723..2805786381 100644 --- a/translations/ja-JP/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/translations/ja-JP/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -90,7 +90,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da 1. To create a release, use the `gh release create` subcommand. Replace `tag` with the desired tag for the release. ```shell - gh release create tag + gh release create TAG ``` 2. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_release_create). For example, this command creates a prerelease with the specified title and notes. @@ -153,7 +153,7 @@ Releases cannot currently be edited with {% data variables.product.prodname_cli 1. To delete a release, use the `gh release delete` subcommand. Replace `tag` with the tag of the release to delete. Use the `-y` flag to skip confirmation. ```shell - gh release delete tag -y + gh release delete TAG -y ``` {% endcli %} diff --git a/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md index 4f76f5e93b..358b0e8a2b 100644 --- a/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md +++ b/translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -1,6 +1,6 @@ --- -title: GitHub での大きいファイルについて -intro: '{% data variables.product.product_name %} には、通常の Git リポジトリで追跡できるファイルのサイズに制限があります。 制限を超えるファイルを追跡または削除する方法について説明します。' +title: About large files on GitHub +intro: '{% data variables.product.product_name %} limits the size of files you can track in regular Git repositories. Learn how to track or remove files that are beyond the limit.' redirect_from: - /articles/distributing-large-binaries - /github/managing-large-files/distributing-large-binaries @@ -22,88 +22,85 @@ versions: ghae: '*' ghec: '*' shortTitle: Large files -ms.openlocfilehash: c9910f669b13c0c2bc4a8517ac6b33476b23b475 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146331649' --- -## {% data variables.product.product_name %} でのサイズ制限について -{% ifversion fpt or ghec %} {% data variables.product.product_name %} は、すべての Git リポジトリに対して十分なストレージを提供するよう努めていますが、ファイルとリポジトリのサイズにはハード制限があります。 ユーザのパフォーマンスと信頼性を確保するため、リポジトリ全体の健全性のシグナルを積極的に監視しています。 リポジトリの健全性は、サイズ、コミット頻度、コンテンツ、構造など、さまざまな相互作用要因の機能よるものです。 +## About size limits on {% data variables.product.product_name %} -### ファイル サイズ制限 +{% ifversion fpt or ghec %} +{% data variables.product.product_name %} tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes. To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health is a function of various interacting factors, including size, commit frequency, contents, and structure. + +### File size limits {% endif %} -{% data variables.product.product_name %} には、リポジトリで許可されるファイルのサイズに制限があります。 {% data variables.large_files.warning_size %}より大きいファイルを追加または更新しようとすると、Gitから警告が表示されます。 変更は引き続きリポジトリに正常にプッシュされますが、パフォーマンスへの影響を最小限に抑えるためにコミットを削除することを検討してもよいでしょう。 詳しくは、「[ファイルをリポジトリの履歴から削除する](#removing-files-from-a-repositorys-history)」をご覧ください。 +{% data variables.product.product_name %} limits the size of files allowed in repositories. If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](#removing-files-from-a-repositorys-history)." {% note %} -**注:** ブラウザーからリポジトリにファイルを追加する場合、そのファイルは {% data variables.large_files.max_github_browser_size %} 以下でなければなりません。 詳細については、「[リポジトリにファイルを追加する](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)」を参照してください。 +**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." {% endnote %} -{% ifversion ghes %}既定では、{% endif %}{% data variables.product.product_name %} は {% data variables.large_files.max_github_size %} を超えるプッシュをブロックします。 {% ifversion ghes %}ただし、サイト管理者は、{% data variables.product.product_location %} に対して異なる制限を構成できます。 詳しくは、「[Git のプッシュ制限を設定](/enterprise/admin/guides/installation/setting-git-push-limits)」をご覧ください。{% endif %} +{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks files larger than {% data variables.large_files.max_github_size %}. {% ifversion ghes %}However, a site administrator can configure a different limit for {% data variables.product.product_location %}. For more information, see "[Setting Git push limits](/enterprise/admin/guides/installation/setting-git-push-limits)."{% endif %} -この制限を超えるファイルを追跡するには、{% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}) を使う必要があります。 詳しくは、「[{% data variables.large_files.product_name_long %} について](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)」をご覧ください。 +To track files beyond this limit, you must use {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}). For more information, see "[About {% data variables.large_files.product_name_long %}](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)." -リポジトリ内で大きなファイルを配布する必要がある場合は、ファイルを追跡するのではなく、{% data variables.product.product_location %} でリリースを作成できます。 詳しくは、「[大きなバイナリを配布する](#distributing-large-binaries)」をご覧ください。 +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %} instead of tracking the files. For more information, see "[Distributing large binaries](#distributing-large-binaries)." -Git は、大きい SQL ファイルを処理するようには設計されていません。 大きいデータベースを他の開発者と共有するには、[Dropbox](https://www.dropbox.com/) を使うことをお勧めします。 +Git is not designed to handle large SQL files. To share large databases with other developers, we recommend using [Dropbox](https://www.dropbox.com/). -{% ifversion fpt or ghec %} -### リポジトリ サイズの制限 +{% ifversion fpt or ghec or ghae %} +### Repository size limits -リポジトリは小さく保ち、理想としては 1GB 未満、および 5GB 未満にすることを強くお勧めします。 リポジトリが小さいほど、クローン作成が速く、操作やメンテナンスが簡単になります。 リポジトリがインフラストラクチャに過度に影響する場合は、{% data variables.contact.github_support %} から是正措置を求めるメールが送られてくる場合があります。 特に多くのコラボレータが参加している大規模なプロジェクトでは、柔軟に対応するよう努めており、可能な限り解決策を見つけるために協力します。 リポジトリのサイズと全体的な健全性を効果的に管理することで、リポジトリがインフラストラクチャに影響を与えることを防ぎます。 [`github/git-sizer`](https://github.com/github/git-sizer) リポジトリには、リポジトリ分析のためのアドバイスとツールがあります。 +We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. {% ifversion ghae %}The maximum size for a repository on {% data variables.product.product_name %} is 100 GB. {% endif %}Smaller repositories are faster to clone and easier to work with and maintain. If your repository excessively impacts our infrastructure, you might receive an email from {% data variables.contact.github_support %} asking you to take corrective action. We try to be flexible, especially with large projects that have many collaborators, and will work with you to find a resolution whenever possible. You can prevent your repository from impacting our infrastructure by effectively managing your repository's size and overall health. You can find advice and a tool for repository analysis in the [`github/git-sizer`](https://github.com/github/git-sizer) repository. -外部依存関係によって、Git リポジトリが非常に大きくなる場合があります。 リポジトリが外部依存関係で埋まってしまうことを避けるために、パッケージマネージャーの使用をお勧めします。 一般的な言語で人気のあるパッケージ マネージャーには、[Bundler](http://bundler.io/)、[Node のパッケージ マネージャー](http://npmjs.org/)、[Maven](http://maven.apache.org/) などがあります。 これらのパッケージマネージャーは Git リポジトリの直接使用をサポートしているため、事前にパッケージ化されたソースは必要ありません。 +External dependencies can cause Git repositories to become very large. To avoid filling a repository with external dependencies, we recommend you use a package manager. Popular package managers for common languages include [Bundler](http://bundler.io/), [Node's Package Manager](http://npmjs.org/), and [Maven](http://maven.apache.org/). These package managers support using Git repositories directly, so you don't need pre-packaged sources. -Git はバックアップツールとして機能するようには設計されていません。 ただし、[Arq](https://www.arqbackup.com/)、[Carbonite](http://www.carbonite.com/)、[CrashPlan](https://www.crashplan.com/en-us/) など、バックアップを実行するために特別に設計された多くのソリューションがあります。 +Git is not designed to serve as a backup tool. However, there are many solutions specifically designed for performing backups, such as [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/), and [CrashPlan](https://www.crashplan.com/en-us/). {% endif %} -## ファイルをリポジトリの履歴から削除する +## Removing files from a repository's history {% warning %} -**警告**: この手順では、ファイルをコンピューターのリポジトリと {% data variables.product.product_location %} から完全に削除します。 ファイルが重要なものである場合は、ローカルバックアップコピーをリポジトリ外にあるディレクトリに作成してください。 +**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.product.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. {% endwarning %} -### プッシュされていない直近のコミットで追加されたファイルを削除する +### Removing a file added in the most recent unpushed commit -ファイルが直近のコミットで追加され、{% data variables.product.product_location %} にプッシュしていない場合は、ファイルを削除してコミットを修正することができます。 +If the file was added with your most recent commit, and you have not pushed to {% data variables.product.product_location %}, you can delete the file and amend the commit: -{% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.switching_directories_procedural %} -3. ファイルを削除するには、「`git rm --cached`」と入力します。 +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +3. To remove the file, enter `git rm --cached`: ```shell - $ git rm --cached giant_file + $ git rm --cached GIANT_FILE # Stage our giant file for removal, but leave it on disk ``` -4. `--amend -CHEAD` を使って、この変更をコミットします。 +4. Commit this change using `--amend -CHEAD`: ```shell $ git commit --amend -CHEAD # Amend the previous commit with your change # Simply making a new commit won't work, as you need # to remove the file from the unpushed history as well ``` -5. コミットを {% data variables.product.product_location %} にプッシュします。 +5. Push your commits to {% data variables.product.product_location %}: ```shell $ git push # Push our rewritten, smaller commit ``` -### 以前のコミットで追加されたファイルを削除する +### Removing a file that was added in an earlier commit -以前のコミットでファイルを追加した場合は、リポジトリの履歴から削除する必要があります。 リポジトリの履歴からファイルを削除するには、BFG Repo-Cleaner または `git filter-branch` コマンドを使用できます。 詳しくは、「[機密データをリポジトリから削除する](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)」をご覧ください。 +If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." -## 大きなバイナリを配布する +## Distributing large binaries -リポジトリ内で大きなファイルを配布する必要がある場合は、{% data variables.product.product_location %}でリリースを作成できます。 リリースでは、他の人が使用できるように、ソフトウェア、リリースノート、バイナリファイルへのリンクをパッケージ化できます。 詳しくは、「[リリースについて](/github/administering-a-repository/about-releases)」をご覧ください。 +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %}. Releases allow you to package software, release notes, and links to binary files, for other people to use. For more information, visit "[About releases](/github/administering-a-repository/about-releases)." {% ifversion fpt or ghec %} -リリース内のバイナリファイルの合計サイズや、それらの配布に使用される帯域は制限されません。 ただし、個々のファイルは{% data variables.large_files.max_lfs_size %}未満でなければなりません。 +We don't limit the total size of the binary files in the release or the bandwidth used to deliver them. However, each individual file must be smaller than {% data variables.large_files.max_lfs_size %}. {% endif %} diff --git a/translations/ja-JP/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/translations/ja-JP/content/repositories/working-with-files/using-files/working-with-non-code-files.md index 2621f90997..229230ac98 100644 --- a/translations/ja-JP/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/translations/ja-JP/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -340,7 +340,7 @@ To view a fully interactive version of your Jupyter Notebook, you can set up a n If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): ```shell -$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb +$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb ``` ### Further reading diff --git a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md index 083950084d..a744b76793 100644 --- a/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md @@ -163,7 +163,7 @@ With cURL, you will send an `Authorization` header with your token. Replace `YOU ```shell curl --request GET \ --url "https://api.github.com/octocat" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% note %} @@ -326,7 +326,7 @@ To send a header with cURL, use the `--header` or `-H` flag followed by the head curl --request GET \ --url "https://api.github.com/octocat" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -390,7 +390,7 @@ To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -443,7 +443,7 @@ For cURL, add a `?` to the end of the path, then append your query parameter nam curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -495,7 +495,7 @@ For cURL, use the `--data` flag to pass the body parameters in a JSON object. curl --request POST \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --data '{ "title": "Created with the REST API", "body": "This is a test issue created by the REST API" @@ -593,7 +593,7 @@ For example, this request: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --include ``` @@ -661,7 +661,7 @@ await octokit.request("GET /repos/{owner}/{repo}/issues", { curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -730,7 +730,7 @@ For example, you can use `>` to redirect the response to a file: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" > data.json +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` Then you can use jq to get the title and author ID of each issue: diff --git a/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md b/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md index ffa76e3719..a369469433 100644 --- a/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md +++ b/translations/ja-JP/content/rest/overview/permissions-required-for-github-apps.md @@ -19,11 +19,12 @@ shortTitle: GitHub App permissions {% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[Setting permissions for GitHub Apps](/apps/building-github-apps/setting-permissions-for-github-apps/)." -## Metadata permissions + +## Metadata -GitHub Apps have the `Read-only` metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. +GitHub Apps have the **Read-only** metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. -{% data reusables.apps.metadata-permissions %} +If you set the metadata permission to **No access** and select a permission that requires repository access, GitHub will override your selection and set the metadata permission back to **Read-only**. To set the metadata permission to **No access**, you must set all permissions that require repository access to **No access** first. - [`GET /`](/rest#root-endpoint) - [`GET /codes_of_conduct`](/rest/reference/codes-of-conduct#get-all-codes-of-conduct) @@ -96,9 +97,6 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe - [`GET /gitignore/templates`](/rest/reference/gitignore#get-all-gitignore-templates) - [`GET /gitignore/templates/:key`](/rest/reference/gitignore#get-a-gitignore-template) -### Keys -- [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) - ### Organization members - [`GET /orgs/:org/members`](/rest/reference/orgs#list-organization-members) - [`GET /orgs/:org/members/:username`](/rest/reference/orgs#check-organization-membership-for-a-user) @@ -114,856 +112,903 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe - [`GET /search/topics`](/rest/reference/search#search-topics) - [`GET /search/users`](/rest/reference/search#search-users) -{% ifversion fpt or ghes or ghec %} -## Permission on "actions" +### SSH keys +- [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) -- [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) -- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (:write) -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (:read) +{% ifversion fpt or ghes or ghec %} + +## Actions + +- [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (read) +- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (write) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (read) {% ifversion actions-cache-management -%} -- [`GET /repos/:owner/:repo/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-a-repository) (read) {% endif -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (read) {% ifversion fpt or ghec -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/approve`](/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/approve`](/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request) (write) {% endif -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (:read) -- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (:write) -- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (:read) -- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (:write) -- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (:write) -- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (:read) -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (:read) -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (read) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (write) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (read) +- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (write) +- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (read) {% endif %} -## Permission on "administration" + +## Administration -- [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (:write) -- [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write) -- [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (:write) -- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write) -- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (:write) -- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (:write) +- [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (write) +- [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (write) +- [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (write) +- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (read) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (write) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (read) +- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (write) +- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (write) {% ifversion fpt or ghec or ghes -%} -- [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write) -- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write) +- [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (write) +- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (:write) +- [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#disable-automated-security-fixes) (:write) +- [`DELETE /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#disable-automated-security-fixes) (write) {% endif -%} -- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (:write) +- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (write) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) (:write) +- [`PUT /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (:write) +- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (write) {% endif -%} {% ifversion ghes > 3.3 -%} -- [`GET /repos/:owner/:repo/replicas/caches`](/rest/reference/repos#list-repository-cache-replication-status) (:read) +- [`GET /repos/:owner/:repo/replicas/caches`](/rest/reference/repos#list-repository-cache-replication-status) (read) {% endif -%} -- [`PUT /repos/:owner/:repo/topics`](/rest/reference/repos#replace-all-repository-topics) (:write) -- [`POST /repos/:owner/:repo/transfer`](/rest/reference/repos#transfer-a-repository) (:write) +- [`PUT /repos/:owner/:repo/topics`](/rest/reference/repos#replace-all-repository-topics) (write) +- [`POST /repos/:owner/:repo/transfer`](/rest/reference/repos#transfer-a-repository) (write) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (:read) +- [`GET /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (:write) +- [`PUT /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#disable-vulnerability-alerts) (:write) +- [`DELETE /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#disable-vulnerability-alerts) (write) {% endif -%} -- [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#accept-a-repository-invitation) (:write) -- [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#decline-a-repository-invitation) (:write) +- [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#accept-a-repository-invitation) (write) +- [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#decline-a-repository-invitation) (write) ### Branches -- [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#get-branch-protection) (:read) -- [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#update-branch-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#delete-branch-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#get-admin-branch-protection) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#set-admin-branch-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#delete-admin-branch-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#get-pull-request-review-protection) (:read) -- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#update-pull-request-review-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#delete-pull-request-review-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#get-commit-signature-protection) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#create-commit-signature-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#delete-commit-signature-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#get-status-checks-protection) (:read) -- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#update-status-check-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#remove-status-check-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#get-all-status-check-contexts) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#add-status-check-contexts) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#set-status-check-contexts) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#remove-status-check-contexts) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#get-access-restrictions) (:read) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#delete-access-restrictions) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#add-team-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#set-team-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#remove-team-access-restrictions) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/repos#list-users-with-access-to-the-protected-branch) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#add-user-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#set-user-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#remove-user-access-restrictions) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (:write) +- [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#get-branch-protection) (read) +- [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#update-branch-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#delete-branch-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#get-admin-branch-protection) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#set-admin-branch-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#delete-admin-branch-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#get-pull-request-review-protection) (read) +- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#update-pull-request-review-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#delete-pull-request-review-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#get-commit-signature-protection) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#create-commit-signature-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#delete-commit-signature-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#get-status-checks-protection) (read) +- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#update-status-check-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#remove-status-check-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#get-all-status-check-contexts) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#add-status-check-contexts) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#set-status-check-contexts) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#remove-status-check-contexts) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#get-access-restrictions) (read) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#delete-access-restrictions) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#add-team-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#set-team-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#remove-team-access-restrictions) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/repos#list-users-with-access-to-the-protected-branch) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#add-user-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#set-user-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#remove-user-access-restrictions) (write) +- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (write) ### Collaborators -- [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#add-a-repository-collaborator) (:write) -- [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#remove-a-repository-collaborator) (:write) +- [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#add-a-repository-collaborator) (write) +- [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#remove-a-repository-collaborator) (write) ### Invitations -- [`GET /repos/:owner/:repo/invitations`](/rest/reference/collaborators#list-repository-invitations) (:read) -- [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#update-a-repository-invitation) (:write) -- [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#delete-a-repository-invitation) (:write) +- [`GET /repos/:owner/:repo/invitations`](/rest/reference/collaborators#list-repository-invitations) (read) +- [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#update-a-repository-invitation) (write) +- [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#delete-a-repository-invitation) (write) -### Keys -- [`GET /repos/:owner/:repo/keys`](/rest/reference/deployments#list-deploy-keys) (:read) -- [`POST /repos/:owner/:repo/keys`](/rest/reference/deployments#create-a-deploy-key) (:write) -- [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#get-a-deploy-key) (:read) -- [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#delete-a-deploy-key) (:write) +### SSH keys +- [`GET /repos/:owner/:repo/keys`](/rest/reference/deployments#list-deploy-keys) (read) +- [`POST /repos/:owner/:repo/keys`](/rest/reference/deployments#create-a-deploy-key) (write) +- [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#get-a-deploy-key) (read) +- [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#delete-a-deploy-key) (write) ### Teams -- [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (:read) -- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:write) -- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) +- [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (read) +- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (write) +- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (write) {% ifversion fpt or ghec %} ### Traffic -- [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repository-metrics#get-repository-clones) (:read) -- [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repository-metrics#get-top-referral-paths) (:read) -- [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repository-metrics#get-top-referral-sources) (:read) -- [`GET /repos/:owner/:repo/traffic/views`](/rest/reference/repository-metrics#get-page-views) (:read) +- [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repository-metrics#get-repository-clones) (read) +- [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repository-metrics#get-top-referral-paths) (read) +- [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repository-metrics#get-top-referral-sources) (read) +- [`GET /repos/:owner/:repo/traffic/views`](/rest/reference/repository-metrics#get-page-views) (read) {% endif %} {% ifversion fpt or ghec %} -## Permission on "blocking" + +## Blocking users -- [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (:read) -- [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (:read) -- [`PUT /user/blocks/:username`](/rest/reference/users#block-a-user) (:write) -- [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (:write) +- [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (read) +- [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (read) +- [`PUT /user/blocks/:username`](/rest/reference/users#block-a-user) (write) +- [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (write) {% endif %} -## Permission on "checks" + +## Checks -- [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (:write) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) -- [`PATCH /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#update-a-check-run) (:write) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (:read) -- [`POST /repos/:owner/:repo/check-suites`](/rest/reference/checks#create-a-check-suite) (:write) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (:read) -- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (:write) -- [`PATCH /repos/:owner/:repo/check-suites/preferences`](/rest/reference/checks#update-repository-preferences-for-check-suites) (:write) -- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) +- [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (read) +- [`PATCH /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#update-a-check-run) (write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (read) +- [`POST /repos/:owner/:repo/check-suites`](/rest/reference/checks#create-a-check-suite) (write) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (read) +- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (write) +- [`PATCH /repos/:owner/:repo/check-suites/preferences`](/rest/reference/checks#update-repository-preferences-for-check-suites) (write) +- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (read) + + +## Code scanning alerts + +- [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (read) +- [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (write) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (read) +{% endif -%} +- [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (read) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (read) +{% endif -%} +{% ifversion fpt or ghec or ghes -%} +- [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (write) +{% endif -%} +- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (write) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (read) +{% endif -%} +{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 -%} +- [`GET /orgs/:org/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-by-organization) (read) +{% endif -%} {% ifversion fpt or ghec %} -## Permission on "codespaces" + +## Codespaces - [`GET /repos/:owner/:repo/codespaces/machines`](/rest/reference/codespaces#list-available-machine-types-for-a-repository) {% endif %} -## Permission on "contents" -- [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (:read) + +## Commit statuses + +- [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) (read) +- [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/commits#list-commit-statuses-for-a-reference) (read) +- [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/commits#create-a-commit-status) (write) + + +## Contents + +- [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (read) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (:write) +- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (:read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (read) {% endif -%} {% ifversion fpt -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (:write) +- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (write) {% endif -%} {% ifversion fpt -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:write) +- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#get-a-repository-secret) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#get-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#create-or-update-a-repository-secret) (:write) +- [`PUT /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#create-or-update-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#delete-a-repository-secret) (:write) +- [`DELETE /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#delete-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (:read) +- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (:read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (read) {% endif -%} -- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (:read) -- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (:write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (read) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (read) +- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (write) {% ifversion codeowners-errors %} -- [`GET /repos/:owner/:repo/codeowners/errors`](/rest/reference/repos#list-codeowners-errors) (:read) +- [`GET /repos/:owner/:repo/codeowners/errors`](/rest/reference/repos#list-codeowners-errors) (read) {% endif %} -- [`GET /repos/:owner/:repo/commits`](/rest/reference/commits#list-commits) (:read) -- [`GET /repos/:owner/:repo/commits/:sha`](/rest/reference/commits#get-a-commit) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/community/code_of_conduct`](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/compare/:base...:head`](/rest/reference/commits#compare-two-commits) (:read) -- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) -- [`POST /repos/:owner/:repo/dispatches`](/rest/reference/repos#create-a-repository-dispatch-event) (:write) -- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (:read) -- [`POST /repos/:owner/:repo/merges`](/rest/reference/branches#merge-a-branch) (:write) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (:read) +- [`GET /repos/:owner/:repo/commits`](/rest/reference/commits#list-commits) (read) +- [`GET /repos/:owner/:repo/commits/:sha`](/rest/reference/commits#get-a-commit) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/community/code_of_conduct`](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) (read) +- [`GET /repos/:owner/:repo/compare/:base...:head`](/rest/reference/commits#compare-two-commits) (read) +- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (read) +- [`POST /repos/:owner/:repo/dispatches`](/rest/reference/repos#create-a-repository-dispatch-event) (write) +- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (read) +- [`POST /repos/:owner/:repo/merges`](/rest/reference/branches#merge-a-branch) (write) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (write) +- [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (read) ### Branches -- [`GET /repos/:owner/:repo/branches`](/rest/reference/branches#list-branches) (:read) -- [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/branches#get-a-branch) (:read) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#add-app-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#set-app-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#remove-user-access-restrictions) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (:write) +- [`GET /repos/:owner/:repo/branches`](/rest/reference/branches#list-branches) (read) +- [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/branches#get-a-branch) (read) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (write) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#add-app-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#set-app-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#remove-user-access-restrictions) (write) +- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (write) ### Commit comments -- [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#update-a-commit-comment) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#delete-a-commit-comment) (:write) -- [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (:write) -- [`POST /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/commits#create-a-commit-comment) (:write) +- [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#update-a-commit-comment) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#delete-a-commit-comment) (write) +- [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (write) +- [`POST /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/commits#create-a-commit-comment) (write) ### Git -- [`POST /repos/:owner/:repo/git/blobs`](/rest/reference/git#create-a-blob) (:write) -- [`GET /repos/:owner/:repo/git/blobs/:sha`](/rest/reference/git#get-a-blob) (:read) -- [`POST /repos/:owner/:repo/git/commits`](/rest/reference/git#create-a-commit) (:write) -- [`GET /repos/:owner/:repo/git/commits/:commit_id`](/rest/reference/git#get-a-commit) (:read) -- [`POST /repos/:owner/:repo/git/refs`](/rest/reference/git#create-a-reference) (:write) -- [`GET /repos/:owner/:repo/git/ref/:ref`](/rest/reference/git#get-a-reference) (:read) -- [`GET /repos/:owner/:repo/git/matching-refs/:ref`](/rest/reference/git#list-matching-references) (:read) -- [`PATCH /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#update-a-reference) (:write) -- [`DELETE /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#delete-a-reference) (:write) -- [`POST /repos/:owner/:repo/git/tags`](/rest/reference/git#create-a-tag-object) (:write) -- [`GET /repos/:owner/:repo/git/tags/:tag_id`](/rest/reference/git#get-a-tag) (:read) -- [`POST /repos/:owner/:repo/git/trees`](/rest/reference/git#create-a-tree) (:write) -- [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (:read) +- [`POST /repos/:owner/:repo/git/blobs`](/rest/reference/git#create-a-blob) (write) +- [`GET /repos/:owner/:repo/git/blobs/:sha`](/rest/reference/git#get-a-blob) (read) +- [`POST /repos/:owner/:repo/git/commits`](/rest/reference/git#create-a-commit) (write) +- [`GET /repos/:owner/:repo/git/commits/:commit_id`](/rest/reference/git#get-a-commit) (read) +- [`POST /repos/:owner/:repo/git/refs`](/rest/reference/git#create-a-reference) (write) +- [`GET /repos/:owner/:repo/git/ref/:ref`](/rest/reference/git#get-a-reference) (read) +- [`GET /repos/:owner/:repo/git/matching-refs/:ref`](/rest/reference/git#list-matching-references) (read) +- [`PATCH /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#update-a-reference) (write) +- [`DELETE /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#delete-a-reference) (write) +- [`POST /repos/:owner/:repo/git/tags`](/rest/reference/git#create-a-tag-object) (write) +- [`GET /repos/:owner/:repo/git/tags/:tag_id`](/rest/reference/git#get-a-tag) (read) +- [`POST /repos/:owner/:repo/git/trees`](/rest/reference/git#create-a-tree) (write) +- [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (read) {% ifversion fpt or ghec %} ### Import -- [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (:read) -- [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (:write) -- [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (:write) -- [`DELETE /repos/:owner/:repo/import`](/rest/reference/migrations#cancel-an-import) (:write) -- [`GET /repos/:owner/:repo/import/authors`](/rest/reference/migrations#get-commit-authors) (:read) -- [`PATCH /repos/:owner/:repo/import/authors/:author_id`](/rest/reference/migrations#map-a-commit-author) (:write) -- [`GET /repos/:owner/:repo/import/large_files`](/rest/reference/migrations#get-large-files) (:read) -- [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (:write) +- [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (read) +- [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (write) +- [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (write) +- [`DELETE /repos/:owner/:repo/import`](/rest/reference/migrations#cancel-an-import) (write) +- [`GET /repos/:owner/:repo/import/authors`](/rest/reference/migrations#get-commit-authors) (read) +- [`PATCH /repos/:owner/:repo/import/authors/:author_id`](/rest/reference/migrations#map-a-commit-author) (write) +- [`GET /repos/:owner/:repo/import/large_files`](/rest/reference/migrations#get-large-files) (read) +- [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (write) {% endif %} ### Reactions - -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) ### Releases -- [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (:read) -- [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (:write) -- [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (:read) -- [`PATCH /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#update-a-release) (:write) -- [`DELETE /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#delete-a-release) (:write) -- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/rest/reference/repos/#list-release-assets) (:read) -- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#get-a-release-asset) (:read) -- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#update-a-release-asset) (:write) -- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#delete-a-release-asset) (:write) -- [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (:read) -- [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (:read) +- [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (read) +- [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (write) +- [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (read) +- [`PATCH /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#update-a-release) (write) +- [`DELETE /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#delete-a-release) (write) +- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/rest/reference/repos/#list-release-assets) (read) +- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#get-a-release-asset) (read) +- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#update-a-release-asset) (write) +- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#delete-a-release-asset) (write) +- [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (read) +- [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (read) -## Permission on "deployments" +{% ifversion dependabot-alerts-rest-api %} +## Dependabot alerts -- [`GET /repos/:owner/:repo/deployments`](/rest/reference/deployments#list-deployments) (:read) -- [`POST /repos/:owner/:repo/deployments`](/rest/reference/deployments#create-a-deployment) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#get-a-deployment) (:read) -- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#delete-a-deployment) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#list-deployment-statuses) (:read) -- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#create-a-deployment-status) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/deployments#get-a-deployment-status) (:read) +- [`GET /repos/:owner/:repo/dependabot/alerts`](/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/dependabot/alerts/:alert_number`](/rest/dependabot/alerts#get-a-dependabot-alert) (read) +- [`PATCH /repos/:owner/:repo/dependabot/alerts/:alert_number`](/rest/dependabot/alerts#update-a-dependabot-alert) (write) +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.3%} + +## Dependabot secrets + +- [`GET /repos/:owner/:repo/dependabot/secrets/public-key`](/rest/reference/dependabot#get-a-repository-public-key) (read) +- [`GET /repos/:owner/:repo/dependabot/secrets`](/rest/reference/dependabot#list-repository-secrets) (read) +- [`GET /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-a-repository-secret) (read) +- [`PUT /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-a-repository-secret) (write) +- [`DELETE /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-a-repository-secret) (write) +- [`GET /orgs/:org/dependabot/secrets/public-key`](/rest/reference/dependabot#get-an-organization-public-key) (read) +- [`GET /orgs/:org/dependabot/secrets`](/rest/reference/dependabot#list-organization-secrets) (read) +- [`GET /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-an-organization-secret) (read) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-an-organization-secret) (write) +- [`GET /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret) (read) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) (write) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#add-selected-repository-to-an-organization-secret) (write) +- [`DELETE /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) (write) +- [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (write) +{% endif %} + + +## Deployments + +- [`GET /repos/:owner/:repo/deployments`](/rest/reference/deployments#list-deployments) (read) +- [`POST /repos/:owner/:repo/deployments`](/rest/reference/deployments#create-a-deployment) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#get-a-deployment) (read) +- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#delete-a-deployment) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#list-deployment-statuses) (read) +- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#create-a-deployment-status) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/deployments#get-a-deployment-status) (read) {% ifversion fpt or ghes or ghec %} -## Permission on "emails" + +## Email addresses {% ifversion fpt or ghec -%} -- [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (:write) +- [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (write) {% endif -%} -- [`GET /user/emails`](/rest/reference/users#list-email-addresses-for-the-authenticated-user) (:read) -- [`POST /user/emails`](/rest/reference/users#add-an-email-address-for-the-authenticated-user) (:write) -- [`DELETE /user/emails`](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) (:write) -- [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (:read) +- [`GET /user/emails`](/rest/reference/users#list-email-addresses-for-the-authenticated-user) (read) +- [`POST /user/emails`](/rest/reference/users#add-an-email-address-for-the-authenticated-user) (write) +- [`DELETE /user/emails`](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) (write) +- [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (read) {% endif %} -## Permission on "followers" + +## Followers -- [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (:read) -- [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (:read) -- [`GET /user/following/:username`](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) (:read) -- [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (:write) -- [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (:write) +- [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (read) +- [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (read) +- [`GET /user/following/:username`](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) (read) +- [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (write) +- [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (write) -## Permission on "gpg keys" + +## Git SSH keys -- [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (:read) -- [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (:write) -- [`GET /user/gpg_keys/:gpg_key_id`](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) (:read) -- [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (:write) +- [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (read) +- [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (write) +- [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (read) +- [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (write) + + +## GPG keys + +- [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (read) +- [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (write) +- [`GET /user/gpg_keys/:gpg_key_id`](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) (read) +- [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (write) {% ifversion fpt or ghec %} -## Permission on "interaction limits" + +## Interaction limits -- [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (:read) -- [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (:write) -- [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (:write) +- [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (read) +- [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (write) +- [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (write) {% endif %} -## Permission on "issues" + +## Issues Issues and pull requests are closely related. For more information, see "[List issues assigned to the authenticated user](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues. -- [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (:read) -- [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#get-an-issue) (:read) -- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (:read) -- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (:read) -- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) +- [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (read) +- [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#get-an-issue) (read) +- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (read) +- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (read) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (read) +- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) ### Assignees -- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) -- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) +- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (read) +- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (write) ### Events -- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) -- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) +- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (read) +- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (read) ### Labels -- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (:write) -- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (:write) -- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (:read) -- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) -- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (write) +- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (read) +- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (write) +- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (read) +- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (write) +- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (write) ### Milestones -- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) -- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) -- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (:write) -- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) +- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (read) +- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (read) +- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (write) +- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (read) ### Reactions -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) -## Permission on "keys" - -### Keys -- [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (:read) -- [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (:write) -- [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (:read) -- [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (:write) - -## Permission on "members" + +## Members {% ifversion fpt or ghec -%} -- [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (:write) +- [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PATCH /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#create-or-update-idp-group-connections) (:write) +- [`PATCH /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#create-or-update-idp-group-connections) (write) {% endif -%} -- [`GET /orgs/:org/outside_collaborators`](/rest/reference/orgs#list-outside-collaborators-for-an-organization) (:read) -- [`PUT /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) (:write) -- [`DELETE /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) (:write) +- [`GET /orgs/:org/outside_collaborators`](/rest/reference/orgs#list-outside-collaborators-for-an-organization) (read) +- [`PUT /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) (write) +- [`DELETE /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) (write) {% ifversion fpt or ghec -%} -- [`GET /orgs/:org/team-sync/groups`](/rest/teams/team-sync#list-idp-groups-for-an-organization) (:write) +- [`GET /orgs/:org/team-sync/groups`](/rest/teams/team-sync#list-idp-groups-for-an-organization) (write) {% endif -%} -- [`GET /orgs/:org/team/:team_id`](/rest/teams/teams#get-a-team-by-name) (:read) +- [`GET /orgs/:org/team/:team_id`](/rest/teams/teams#get-a-team-by-name) (read) {% ifversion fpt or ghec -%} -- [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (:write) +- [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`POST /scim/v2/orgs/:org/Users`](/rest/reference/scim#provision-and-invite-a-scim-user) (:write) +- [`POST /scim/v2/orgs/:org/Users`](/rest/reference/scim#provision-and-invite-a-scim-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (:write) +- [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#set-scim-information-for-a-provisioned-user) (:write) +- [`PUT /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#set-scim-information-for-a-provisioned-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PATCH /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#update-an-attribute-for-a-scim-user) (:write) +- [`PATCH /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#update-an-attribute-for-a-scim-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#delete-a-scim-user-from-an-organization) (:write) +- [`DELETE /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#delete-a-scim-user-from-an-organization) (write) {% endif %} {% ifversion fpt or ghec %} ### Invitations -- [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (:read) -- [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (:write) -- [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (:read) -- [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (:read) +- [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (read) +- [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (write) +- [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (read) +- [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (read) {% endif %} ### Organization members -- [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (:write) -- [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (:read) -- [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (:write) -- [`DELETE /orgs/:org/memberships/:username`](/rest/reference/orgs#remove-organization-membership-for-a-user) (:write) -- [`PUT /orgs/:org/public_members/:username`](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) (:write) -- [`DELETE /orgs/:org/public_members/:username`](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) (:write) -- [`GET /user/memberships/orgs`](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) (:read) -- [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (:read) -- [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (:write) +- [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (write) +- [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (read) +- [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (write) +- [`DELETE /orgs/:org/memberships/:username`](/rest/reference/orgs#remove-organization-membership-for-a-user) (write) +- [`PUT /orgs/:org/public_members/:username`](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) (write) +- [`DELETE /orgs/:org/public_members/:username`](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) (write) +- [`GET /user/memberships/orgs`](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) (read) +- [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (read) +- [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (write) ### Team members -- [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (:read) -- [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (:read) -- [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (:write) -- [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (:write) +- [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (read) +- [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (read) +- [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (write) +- [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (write) ### Teams -- [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (:read) -- [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (:write) -- [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (:read) -- [`PATCH /teams/:team_id`](/rest/reference/teams#update-a-team) (:write) -- [`DELETE /teams/:team_id`](/rest/reference/teams#delete-a-team) (:write) -- [`GET /teams/:team_id/projects`](/rest/reference/teams#list-team-projects) (:read) -- [`GET /teams/:team_id/projects/:project_id`](/rest/reference/teams#check-team-permissions-for-a-project) (:read) -- [`PUT /teams/:team_id/projects/:project_id`](/rest/reference/teams#add-or-update-team-project-permissions) (:read) -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) -- [`GET /teams/:team_id/repos`](/rest/reference/teams#list-team-repositories) (:read) -- [`GET /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#check-team-permissions-for-a-repository) (:read) -- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:read) -- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) -- [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (:read) +- [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (read) +- [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (write) +- [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (read) +- [`PATCH /teams/:team_id`](/rest/reference/teams#update-a-team) (write) +- [`DELETE /teams/:team_id`](/rest/reference/teams#delete-a-team) (write) +- [`GET /teams/:team_id/projects`](/rest/reference/teams#list-team-projects) (read) +- [`GET /teams/:team_id/projects/:project_id`](/rest/reference/teams#check-team-permissions-for-a-project) (read) +- [`PUT /teams/:team_id/projects/:project_id`](/rest/reference/teams#add-or-update-team-project-permissions) (read) +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) +- [`GET /teams/:team_id/repos`](/rest/reference/teams#list-team-repositories) (read) +- [`GET /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#check-team-permissions-for-a-repository) (read) +- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (read) +- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (write) +- [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (read) -## Permission on "organization administration" + +## Organization administration -- [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (:write) +- [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (write) {% ifversion actions-cache-management -%} -- [`GET /orgs/:org/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-an-organization) (:read) -- [`GET /orgs/:org/actions/cache/usage-by-repository`](/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization) (:read) +- [`GET /orgs/:org/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-an-organization) (read) +- [`GET /orgs/:org/actions/cache/usage-by-repository`](/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /orgs/:org/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) (:read) +- [`GET /orgs/:org/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /orgs/:org/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) (:write) +- [`PUT /orgs/:org/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (:write) +- [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (write) {% endif %} -## Permission on "organization events" + +## Organization events -- [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (:read) - -## Permission on "organization hooks" - -- [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (:read) -- [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (:write) -- [`GET /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#get-an-organization-webhook) (:read) -- [`PATCH /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#update-an-organization-webhook) (:write) -- [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (:write) -- [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (:write) - -### Teams -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) +- [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (read) {% ifversion ghes %} -## Permission on "organization pre receive hooks" + +## Organization pre-receive hooks -- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read) -- [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (:read) -- [`PATCH /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) (:write) -- [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (:write) +- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (read) +- [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (read) +- [`PATCH /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) (write) +- [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (write) {% endif %} -## Permission on "organization projects" + +## Organization projects -- [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (:write) -- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) -- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) -- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (:write) -- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (:read) -- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (:write) -- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (:read) -- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (:write) -- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (:write) -- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (:read) -- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (:write) -- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (:read) -- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (:write) -- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (:write) -- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) +- [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (write) +- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (read) +- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (write) +- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (write) +- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (read) +- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (write) +- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (read) +- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (write) +- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (write) +- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (read) +- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (write) +- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (read) +- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (write) +- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (write) +- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (write) {% ifversion fpt or ghec %} -## Permission on "organization user blocking" + +## Organization user blocking -- [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (:read) -- [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (:read) -- [`PUT /orgs/:org/blocks/:username`](/rest/reference/orgs#block-a-user-from-an-organization) (:write) -- [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (:write) +- [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (read) +- [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (read) +- [`PUT /orgs/:org/blocks/:username`](/rest/reference/orgs#block-a-user-from-an-organization) (write) +- [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (write) {% endif %} -## Permission on "pages" + +## Organization webhooks + +- [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (read) +- [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (write) +- [`GET /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#get-an-organization-webhook) (read) +- [`PATCH /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#update-an-organization-webhook) (write) +- [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (write) +- [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (write) + +### Teams +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) + + +## Pages GitHub Pages can only be created or unpublished by a repository owner or administrator. -- [`GET /repos/:owner/:repo/pages`](/rest/reference/pages#get-a-github-pages-site) (:read) -- [`PUT /repos/:owner/:repo/pages`](/rest/reference/pages#update-information-about-a-github-pages-site) (:write) -- [`GET /repos/:owner/:repo/pages/builds`](/rest/reference/pages#list-github-pages-builds) (:read) -- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/pages#request-a-github-pages-build) (:write) -- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/pages#get-github-pages-build) (:read) -- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/pages#get-latest-pages-build) (:read) +- [`GET /repos/:owner/:repo/pages`](/rest/reference/pages#get-a-github-pages-site) (read) +- [`PUT /repos/:owner/:repo/pages`](/rest/reference/pages#update-information-about-a-github-pages-site) (write) +- [`GET /repos/:owner/:repo/pages/builds`](/rest/reference/pages#list-github-pages-builds) (read) +- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/pages#request-a-github-pages-build) (write) +- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/pages#get-github-pages-build) (read) +- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/pages#get-latest-pages-build) (read) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (:write) -- [`POST /repos/:owner/:repo/pages/deployment`](/rest/reference/repos#create-a-github-pages-deployment) (:write) +- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (write) +- [`POST /repos/:owner/:repo/pages/deployment`](/rest/reference/repos#create-a-github-pages-deployment) (write) {% endif %} -## Permission on "pull requests" + +## Profile + +- [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (write) + + +## Pull requests Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. -- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (:read) -- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (:read) -- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/pulls`](/rest/reference/pulls#list-pull-requests) (:read) -- [`POST /repos/:owner/:repo/pulls`](/rest/reference/pulls#create-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#get-a-pull-request) (:read) -- [`PATCH /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#update-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#list-review-comments-on-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/commits`](/rest/reference/pulls#list-commits-on-a-pull-request) (:read) -- [`GET /repos/:owner/:repo/pulls/:pull_number/files`](/rest/reference/pulls#list-pull-requests-files) (:read) -- [`GET /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) (:read) -- [`GET /repos/:owner/:repo/pulls/comments`](/rest/reference/pulls#list-review-comments-in-a-repository) (:read) -- [`GET /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) (:read) -- [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (:write) +- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (read) +- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (read) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (read) +- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/pulls`](/rest/reference/pulls#list-pull-requests) (read) +- [`POST /repos/:owner/:repo/pulls`](/rest/reference/pulls#create-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#get-a-pull-request) (read) +- [`PATCH /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#update-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#list-review-comments-on-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/commits`](/rest/reference/pulls#list-commits-on-a-pull-request) (read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/files`](/rest/reference/pulls#list-pull-requests-files) (read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) (read) +- [`GET /repos/:owner/:repo/pulls/comments`](/rest/reference/pulls#list-review-comments-in-a-repository) (read) +- [`GET /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) (read) +- [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (write) ### Assignees -- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) -- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) +- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (read) +- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (write) ### Events -- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) -- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (read) +- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (write) ### Labels -- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (:write) -- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (:write) -- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (:read) -- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) -- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (write) +- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (read) +- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (write) +- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (read) +- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (write) +- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (write) ### Milestones -- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) -- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) -- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (:write) -- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) +- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (read) +- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (read) +- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (write) +- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (read) ### Reactions -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) (:read) -- [`POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) (:write) -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) (read) +- [`POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) (write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) ### Requested reviewers -- [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (:write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (write) ### Reviews -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (:read) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#update-a-review-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#delete-a-pending-review-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (:read) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (:write) - -## Permission on "profile" - -- [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (:write) - -## Permission on "repository hooks" - -- [`GET /repos/:owner/:repo/hooks`](/rest/reference/webhooks#list-repository-webhooks) (:read) -- [`POST /repos/:owner/:repo/hooks`](/rest/reference/webhooks#create-a-repository-webhook) (:write) -- [`GET /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#get-a-repository-webhook) (:read) -- [`PATCH /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#update-a-repository-webhook) (:write) -- [`DELETE /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#delete-a-repository-webhook) (:write) -- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/rest/reference/webhooks#ping-a-repository-webhook) (:read) -- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (:read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (read) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#update-a-review-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#delete-a-pending-review-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (read) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (write) {% ifversion ghes %} -## Permission on "repository pre receive hooks" + +## Repository pre-receive hooks -- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (:read) -- [`PATCH /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (:write) +- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (read) +- [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (read) +- [`PATCH /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (write) {% endif %} -## Permission on "repository projects" + +## Repository projects -- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) -- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) -- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (:write) -- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (:read) -- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (:write) -- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (:read) -- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (:write) -- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (:write) -- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (:read) -- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (:write) -- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (:read) -- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (:write) -- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (:write) -- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) -- [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (:read) -- [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (:write) +- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (read) +- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (write) +- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (write) +- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (read) +- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (write) +- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (read) +- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (write) +- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (write) +- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (read) +- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (write) +- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (read) +- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (write) +- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (write) +- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (write) +- [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (read) +- [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (write) ### Teams -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) + + +## Repository webhooks + +- [`GET /repos/:owner/:repo/hooks`](/rest/reference/webhooks#list-repository-webhooks) (read) +- [`POST /repos/:owner/:repo/hooks`](/rest/reference/webhooks#create-a-repository-webhook) (write) +- [`GET /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#get-a-repository-webhook) (read) +- [`PATCH /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#update-a-repository-webhook) (write) +- [`DELETE /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#delete-a-repository-webhook) (write) +- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/rest/reference/webhooks#ping-a-repository-webhook) (read) +- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (read) {% ifversion fpt or ghec %} -## Permission on "secrets" + +## Secrets -- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:read) -- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:read) -- [`GET /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#get-a-repository-secret) (:read) -- [`PUT /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-a-repository-secret) (:write) -- [`DELETE /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#delete-a-repository-secret) (:write) -- [`GET /orgs/:org/actions/secrets/public-key`](/rest/reference/actions#get-an-organization-public-key) (:read) -- [`GET /orgs/:org/actions/secrets`](/rest/reference/actions#list-organization-secrets) (:read) -- [`GET /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#get-an-organization-secret) (:read) -- [`PUT /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-an-organization-secret) (:write) -- [`GET /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) (:read) -- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) (:write) -- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#add-selected-repository-to-an-organization-secret) (:write) -- [`DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) (:write) -- [`DELETE /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#delete-an-organization-secret) (:write) -{% endif %} - -{% ifversion fpt or ghec or ghes > 3.3%} -## Permission on "dependabot_secrets" -- [`GET /repos/:owner/:repo/dependabot/secrets/public-key`](/rest/reference/dependabot#get-a-repository-public-key) (:read) -- [`GET /repos/:owner/:repo/dependabot/secrets`](/rest/reference/dependabot#list-repository-secrets) (:read) -- [`GET /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-a-repository-secret) (:read) -- [`PUT /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-a-repository-secret) (:write) -- [`DELETE /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-a-repository-secret) (:write) -- [`GET /orgs/:org/dependabot/secrets/public-key`](/rest/reference/dependabot#get-an-organization-public-key) (:read) -- [`GET /orgs/:org/dependabot/secrets`](/rest/reference/dependabot#list-organization-secrets) (:read) -- [`GET /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-an-organization-secret) (:read) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-an-organization-secret) (:write) -- [`GET /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret) (:read) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) (:write) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#add-selected-repository-to-an-organization-secret) (:write) -- [`DELETE /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) (:write) -- [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (read) +- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (read) +- [`GET /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#get-a-repository-secret) (read) +- [`PUT /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-a-repository-secret) (write) +- [`DELETE /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#delete-a-repository-secret) (write) +- [`GET /orgs/:org/actions/secrets/public-key`](/rest/reference/actions#get-an-organization-public-key) (read) +- [`GET /orgs/:org/actions/secrets`](/rest/reference/actions#list-organization-secrets) (read) +- [`GET /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#get-an-organization-secret) (read) +- [`PUT /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-an-organization-secret) (write) +- [`GET /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) (read) +- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) (write) +- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#add-selected-repository-to-an-organization-secret) (write) +- [`DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) (write) +- [`DELETE /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#delete-an-organization-secret) (write) {% endif %} {% ifversion ghes or ghec %} -## Permission on "secret scanning alerts" + +## Secret scanning alerts -- [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (:read) -- [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) -- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations`](/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert) (:read) +- [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (read) +- [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (write) +- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations`](/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert) (read) {% endif %} -## Permission on "security events" - -- [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) -- [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (:write) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (:read) -{% endif -%} -- [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (:read) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (:read) -{% endif -%} -{% ifversion fpt or ghec or ghes -%} -- [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (:write) -{% endif -%} -- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (:write) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (:read) -{% endif -%} -{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 -%} -- [`GET /orgs/:org/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-by-organization) (:read) -{% endif -%} - {% ifversion fpt or ghes or ghec %} -## Permission on "self-hosted runners" -- [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (:write) -- [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (:read) -- [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (:write) -- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (:write) -- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (:write) + +## Self-hosted runners + +- [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (write) +- [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (read) +- [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (write) +- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (write) +- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (write) {% endif %} -## Permission on "single file" + +## Single file -- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) -- [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (:write) -- [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (:write) +- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (read) +- [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (write) +- [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (write) -## Permission on "starring" + +## Starring -- [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (:read) -- [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (:write) -- [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (:write) +- [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (read) +- [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (write) +- [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (write) -## Permission on "statuses" + +## Team discussions -- [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/commits#list-commit-statuses-for-a-reference) (:read) -- [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/commits#create-a-commit-status) (:write) - -## Permission on "team discussions" - -- [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (:read) -- [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#get-a-discussion) (:read) -- [`PATCH /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#update-a-discussion) (:write) -- [`DELETE /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#delete-a-discussion) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#list-discussion-comments) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#create-a-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#get-a-discussion-comment) (:read) -- [`PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#update-a-discussion-comment) (:write) -- [`DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#delete-a-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion) (:write) +- [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (read) +- [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (write) +- [`GET /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#get-a-discussion) (read) +- [`PATCH /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#update-a-discussion) (write) +- [`DELETE /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#delete-a-discussion) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#list-discussion-comments) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#create-a-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#get-a-discussion-comment) (read) +- [`PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#update-a-discussion-comment) (write) +- [`DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#delete-a-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion) (write) diff --git a/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index dcf929a857..4e6d036ae3 100644 --- a/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/ja-JP/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -268,7 +268,7 @@ You can filter pull requests based on their [review status](/pull-requests/colla | reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) matches pull requests reviewed by a particular person. | review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) matches pull requests where a specific person is requested for review. Requested reviewers are no longer listed in the search results after they review a pull request. If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} | user-review-requested:@me | [**type:pr user-review-requested:@me**](https://github.com/search?q=is%3Apr+user-review-requested%3A%40me+) matches pull requests that you have directly been asked to review.{% endif %} -| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) matches pull requests that have review requests from the team `atom/design`. Requested reviewers are no longer listed in the search results after they review a pull request. +| team-review-requested:TEAMNAME | [**type:pr team-review-requested:github/docs**](https://github.com/search?q=type%3Apr+team-review-requested%3Agithub%2Fdocs&type=pullrequests) matches pull requests that have review requests from the team `github/docs`. Requested reviewers are no longer listed in the search results after they review a pull request. ## Search by when an issue or pull request was created or last updated diff --git a/translations/ja-JP/data/reusables/actions/link-to-example-library.md b/translations/ja-JP/data/reusables/actions/link-to-example-library.md deleted file mode 100644 index b576265720..0000000000 --- a/translations/ja-JP/data/reusables/actions/link-to-example-library.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -ms.openlocfilehash: ad73c4455042d29d72d3f76dbbdc512487c9303a -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: "146139469" ---- -{% data variables.product.prodname_actions %} のより複雑な機能を示す例については、「[例](/actions/examples)」を参照してください。 ランナーでコードをテストする方法、{% data variables.product.prodname_dotcom %} CLI にアクセスする方法、コンカレンシーやテスト マトリックスなどの高度な機能を使用する方法を説明する詳しい例を確認できます。 diff --git a/translations/ja-JP/data/reusables/apps/metadata-permissions.md b/translations/ja-JP/data/reusables/apps/metadata-permissions.md deleted file mode 100644 index e04af97014..0000000000 --- a/translations/ja-JP/data/reusables/apps/metadata-permissions.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -ms.openlocfilehash: 5cbe77b1e8580e79c7e77b99de3e1973191d2075 -ms.sourcegitcommit: 5b1461b419dbef60ae9dbdf8e905a4df30fc91b7 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/10/2022 -ms.locfileid: "147878807" ---- -メタデータの権限を `No access` に設定し、リポジトリへのアクセスを必要とする権限を選んだら、GitHub はその選択をオーバーライドし、メタデータの権限を `Read-only` に戻して設定します。 メタデータのアクセス許可を `No access` に設定するには、リポジトリへのアクセスを必要とするすべての権限を、最初に `No access` に設定する必要があります。 diff --git a/translations/ja-JP/data/reusables/codespaces/creating-a-codespace-in-vscode.md b/translations/ja-JP/data/reusables/codespaces/creating-a-codespace-in-vscode.md index 4f150af299..c89126ae76 100644 --- a/translations/ja-JP/data/reusables/codespaces/creating-a-codespace-in-vscode.md +++ b/translations/ja-JP/data/reusables/codespaces/creating-a-codespace-in-vscode.md @@ -15,6 +15,8 @@ After you connect your account on {% data variables.product.product_location %} ![Searching for repository to create a new codespace](/assets/images/help/codespaces/choose-repository-vscode.png) + If codespaces are billable for the repository you choose, a message will be displayed in subsequent prompts telling you who will pay for the codespace. + 4. Click the branch you want to develop on. ![Searching for a branch to create a new codespace](/assets/images/help/codespaces/choose-branch-vscode.png) diff --git a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md index 0dd0b63cbf..4f702e6e70 100644 --- a/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -1,27 +1,22 @@ ---- -ms.openlocfilehash: 5120f840aab87ca243eed66c5bb6256e80aefeea -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: ja-JP -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147064179" ---- -{% ifversion fpt or ghec %}既定では、次のようにして通知を受け取ります。{% endif %}{% ifversion ghes or ghae %}既定では、エンタープライズ所有者がインスタンスで通知用にメールを構成している場合、{% data variables.product.prodname_dependabot_alerts %} を次のように受け取ります。{% endif %} +{% ifversion fpt or ghec %}By default, you will receive notifications:{% endif %}{% ifversion ghes or ghae %}By default, if your enterprise owner has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} -- メール。{% data variables.product.prodname_dependabot %}がリポジトリで有効にされていて、新しいマニフェスト ファイルがリポジトリにコミットされたときに、重要度が重大または高の新しい脆弱性が見つかると、メールが送信されます ( **[脆弱性が見つかるたびにメールを送る]** オプション)。 -- ユーザー インターフェイス。セキュリティで保護されていない依存関係がある場合、リポジトリのファイル ビューとコード ビューに警告が表示されます ( **[UI alerts]\(UI アラート\)** オプション)。 -- コマンド ライン。セキュリティで保護されていない依存関係を使用してリポジトリにプッシュすると、警告がコールバックとして表示されます ( **[Command Line]\(コマンド ライン\)** オプション)。 -- インボックス (Web 通知として)。 Web 通知は、{% data variables.product.prodname_dependabot %} がリポジトリで有効にされていて、新しいマニフェスト ファイルがリポジトリにコミットされたときに、重要度が重大または高の新しい脆弱性が見つかった場合に送信されます ( **[Web]** オプション)。{% ifversion not ghae %} -- {% data variables.product.prodname_mobile %}では、Web通知として表示されます。 詳細については、「[GitHub Mobile でプッシュ通知を有効にする](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)」を参照してください。{% endif %} +- by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email each time a vulnerability is found** option). +- in the user interface, a warning is shown in your repository's file and code views if there are any insecure dependencies (**UI alerts** option). +- on the command line, warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**Command Line** option). +- in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Web** option).{% ifversion not ghae %} +- on {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[Enabling push notifications with GitHub Mobile](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)."{% endif %} {% note %} -**注:** メールと Web{% ifversion not ghae %}/{% data variables.product.prodname_mobile %}{% endif %} の通知は次のとおりです。 +**Note:** The email and web{% ifversion not ghae %}/{% data variables.product.prodname_mobile %}{% endif %} notifications are: -- {% data variables.product.prodname_dependabot %} がリポジトリで有効にされているとき、または新しいマニフェスト ファイルがリポジトリにコミットされたときは、_リポジトリごと_。 +- _per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. -- 新しい脆弱性が検出されたときは、_Organization ごと_。 +- _per organization_ when a new vulnerability is discovered. {% endnote %} -{% data variables.product.prodname_dependabot_alerts %} に関する通知を受け取る方法をカスタマイズできます。 たとえば、 **[脆弱性の要約をメールで送る]** と **[週単位のセキュリティ メール ダイジェスト]** オプションを使用すると、最大 10 個のリポジトリについてアラートを要約した週単位のダイジェスト メールを受け取ることができます。 +{% ifversion update-notification-settings-22 %} +You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a daily or weekly digest email summarizing alerts for up to 10 of your repositories using the **Email weekly digest** option. +{% else %} +You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the **Email a digest summary of vulnerabilities** and **Weekly security email digest** options.{% endif %} diff --git a/translations/log/msft-es-resets.csv b/translations/log/msft-es-resets.csv index 21ab5e751c..6ca4a9a2da 100644 --- a/translations/log/msft-es-resets.csv +++ b/translations/log/msft-es-resets.csv @@ -178,8 +178,10 @@ translations/es-ES/content/sponsors/receiving-sponsorships-through-github-sponso translations/es-ES/data/glossaries/internal.yml,file deleted because it no longer exists in main translations/es-ES/data/graphql/ghes-3.1/graphql_previews.enterprise.yml,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/jobs/section-using-a-build-matrix-for-your-jobs-strategy.md,file deleted because it no longer exists in main +translations/es-ES/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main +translations/es-ES/data/reusables/apps/metadata-permissions.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/billing/per-user-pricing-reference.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/codespaces/about-billing-for-codespaces.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/codespaces/availability.md,file deleted because it no longer exists in main @@ -250,8 +252,10 @@ translations/es-ES/data/reusables/rest-reference/webhooks/repos.md,file deleted translations/es-ES/data/reusables/security-center/beta.md,file deleted because it no longer exists in main translations/es-ES/data/reusables/server-statistics/release-phase.md,file deleted because it no longer exists in main translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md,rendering error +translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md,broken liquid tags translations/es-ES/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md,rendering error +translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md,broken liquid tags translations/es-ES/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md,broken liquid tags translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md,rendering error translations/es-ES/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md,rendering error @@ -300,13 +304,14 @@ translations/es-ES/content/actions/using-workflows/workflow-syntax-for-github-ac translations/es-ES/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance.md,broken liquid tags translations/es-ES/content/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise.md,rendering error translations/es-ES/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,rendering error -translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,broken liquid tags +translations/es-ES/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,rendering error translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises.md,rendering error translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md,rendering error translations/es-ES/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md,rendering error translations/es-ES/content/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users.md,broken liquid tags translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise.md,rendering error translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md,rendering error +translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md,broken liquid tags translations/es-ES/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md,rendering error translations/es-ES/content/admin/overview/accessing-compliance-reports-for-your-enterprise.md,broken liquid tags translations/es-ES/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md,broken liquid tags @@ -348,6 +353,7 @@ translations/es-ES/content/code-security/code-scanning/using-codeql-code-scannin translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error translations/es-ES/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags translations/es-ES/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md,rendering error +translations/es-ES/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,broken liquid tags translations/es-ES/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md,broken liquid tags translations/es-ES/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md,rendering error translations/es-ES/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md,rendering error @@ -423,22 +429,30 @@ translations/es-ES/content/codespaces/troubleshooting/troubleshooting-your-conne translations/es-ES/content/communities/documenting-your-project-with-wikis/about-wikis.md,rendering error translations/es-ES/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md,rendering error translations/es-ES/content/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-personal-account.md,rendering error +translations/es-ES/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md,broken liquid tags translations/es-ES/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide.md,broken liquid tags translations/es-ES/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code.md,broken liquid tags translations/es-ES/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio.md,broken liquid tags translations/es-ES/content/copilot/quickstart.md,broken liquid tags +translations/es-ES/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md,broken liquid tags translations/es-ES/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md,broken liquid tags translations/es-ES/content/developers/overview/about-githubs-apis.md,broken liquid tags +translations/es-ES/content/developers/overview/managing-deploy-keys.md,broken liquid tags translations/es-ES/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md,rendering error translations/es-ES/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md,broken liquid tags translations/es-ES/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md,broken liquid tags translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md,broken liquid tags translations/es-ES/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md,broken liquid tags translations/es-ES/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md,broken liquid tags +translations/es-ES/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md,broken liquid tags translations/es-ES/content/get-started/exploring-projects-on-github/following-organizations.md,broken liquid tags +translations/es-ES/content/get-started/getting-started-with-git/associating-text-editors-with-git.md,broken liquid tags translations/es-ES/content/get-started/learning-about-github/about-github-advanced-security.md,rendering error translations/es-ES/content/get-started/quickstart/be-social.md,broken liquid tags +translations/es-ES/content/get-started/quickstart/communicating-on-github.md,broken liquid tags +translations/es-ES/content/get-started/quickstart/git-and-github-learning-resources.md,broken liquid tags translations/es-ES/content/get-started/using-github/keyboard-shortcuts.md,rendering error +translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md,broken liquid tags translations/es-ES/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error translations/es-ES/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md,broken liquid tags translations/es-ES/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md,rendering error @@ -474,6 +488,7 @@ translations/es-ES/content/packages/managing-github-packages-using-github-action translations/es-ES/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md,rendering error translations/es-ES/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md,rendering error translations/es-ES/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md,rendering error +translations/es-ES/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md,broken liquid tags translations/es-ES/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md,broken liquid tags translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md,rendering error translations/es-ES/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch.md,rendering error @@ -499,6 +514,7 @@ translations/es-ES/content/repositories/releasing-projects-on-github/about-relea translations/es-ES/content/repositories/releasing-projects-on-github/comparing-releases.md,rendering error translations/es-ES/content/repositories/releasing-projects-on-github/linking-to-releases.md,rendering error translations/es-ES/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md,rendering error +translations/es-ES/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md,broken liquid tags translations/es-ES/content/repositories/working-with-files/using-files/working-with-non-code-files.md,rendering error translations/es-ES/content/rest/dependabot/index.md,broken liquid tags translations/es-ES/content/rest/guides/getting-started-with-the-rest-api.md,broken liquid tags @@ -610,6 +626,7 @@ translations/es-ES/data/reusables/gated-features/dependency-vulnerable-calls.md, translations/es-ES/data/reusables/gated-features/secret-scanning-partner.md,rendering error translations/es-ES/data/reusables/gated-features/secret-scanning.md,rendering error translations/es-ES/data/reusables/notifications-v2/custom-notification-types.md,broken liquid tags +translations/es-ES/data/reusables/notifications/vulnerable-dependency-notification-options.md,broken liquid tags translations/es-ES/data/reusables/organizations/billing_plans.md,rendering error translations/es-ES/data/reusables/organizations/github-apps-settings-sidebar.md,rendering error translations/es-ES/data/reusables/organizations/member-privileges.md,rendering error diff --git a/translations/log/msft-ja-resets.csv b/translations/log/msft-ja-resets.csv index a452a74afa..9742b8ad4c 100644 --- a/translations/log/msft-ja-resets.csv +++ b/translations/log/msft-ja-resets.csv @@ -184,8 +184,10 @@ translations/ja-JP/content/site-policy/github-terms/github-community-forum-code- translations/ja-JP/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md,file deleted because it no longer exists in main translations/ja-JP/data/glossaries/internal.yml,file deleted because it no longer exists in main translations/ja-JP/data/graphql/ghes-3.1/graphql_previews.enterprise.yml,file deleted because it no longer exists in main +translations/ja-JP/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main +translations/ja-JP/data/reusables/apps/metadata-permissions.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/billing/per-user-pricing-reference.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/codespaces/about-billing-for-codespaces.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/codespaces/availability.md,file deleted because it no longer exists in main @@ -246,8 +248,10 @@ translations/ja-JP/data/reusables/rest-reference/webhooks/repos.md,file deleted translations/ja-JP/data/reusables/security-center/beta.md,file deleted because it no longer exists in main translations/ja-JP/data/reusables/server-statistics/release-phase.md,file deleted because it no longer exists in main translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md,rendering error +translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md,broken liquid tags translations/ja-JP/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md,rendering error +translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md,broken liquid tags translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md,broken liquid tags translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md,rendering error translations/ja-JP/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository.md,rendering error @@ -298,7 +302,7 @@ translations/ja-JP/content/actions/using-workflows/workflow-syntax-for-github-ac translations/ja-JP/content/admin/code-security/managing-github-advanced-security-for-your-enterprise/configuring-code-scanning-for-your-appliance.md,broken liquid tags translations/ja-JP/content/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise.md,rendering error translations/ja-JP/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,rendering error -translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,broken liquid tags +translations/ja-JP/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,rendering error translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises.md,rendering error translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md,rendering error translations/ja-JP/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md,rendering error @@ -306,6 +310,7 @@ translations/ja-JP/content/admin/identity-and-access-management/using-enterprise translations/ja-JP/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/saml-configuration-reference.md,rendering error translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise.md,rendering error translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md,rendering error +translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md,broken liquid tags translations/ja-JP/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md,rendering error translations/ja-JP/content/admin/overview/accessing-compliance-reports-for-your-enterprise.md,broken liquid tags translations/ja-JP/content/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise.md,broken liquid tags @@ -339,6 +344,7 @@ translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scannin translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error translations/ja-JP/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags translations/ja-JP/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md,rendering error +translations/ja-JP/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,broken liquid tags translations/ja-JP/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md,broken liquid tags translations/ja-JP/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md,rendering error translations/ja-JP/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md,rendering error @@ -412,23 +418,31 @@ translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-dotfiles-f translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-prebuilds.md,broken liquid tags translations/ja-JP/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md,broken liquid tags translations/ja-JP/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md,rendering error +translations/ja-JP/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md,broken liquid tags translations/ja-JP/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide.md,broken liquid tags translations/ja-JP/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code.md,broken liquid tags translations/ja-JP/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio.md,broken liquid tags translations/ja-JP/content/copilot/quickstart.md,broken liquid tags +translations/ja-JP/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md,broken liquid tags translations/ja-JP/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md,rendering error translations/ja-JP/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md,broken liquid tags translations/ja-JP/content/developers/overview/about-githubs-apis.md,broken liquid tags +translations/ja-JP/content/developers/overview/managing-deploy-keys.md,broken liquid tags translations/ja-JP/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md,rendering error translations/ja-JP/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md,broken liquid tags translations/ja-JP/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md,broken liquid tags translations/ja-JP/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md,broken liquid tags translations/ja-JP/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md,broken liquid tags +translations/ja-JP/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md,broken liquid tags +translations/ja-JP/content/get-started/getting-started-with-git/associating-text-editors-with-git.md,broken liquid tags translations/ja-JP/content/get-started/learning-about-github/about-github-advanced-security.md,rendering error +translations/ja-JP/content/get-started/quickstart/communicating-on-github.md,broken liquid tags +translations/ja-JP/content/get-started/quickstart/git-and-github-learning-resources.md,broken liquid tags translations/ja-JP/content/get-started/signing-up-for-github/signing-up-for-a-new-github-account.md,rendering error translations/ja-JP/content/get-started/using-github/github-desktop.md,broken liquid tags translations/ja-JP/content/get-started/using-github/keyboard-shortcuts.md,rendering error translations/ja-JP/content/get-started/using-github/troubleshooting-connectivity-problems.md,broken liquid tags +translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md,broken liquid tags translations/ja-JP/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error translations/ja-JP/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md,broken liquid tags translations/ja-JP/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md,rendering error @@ -460,6 +474,7 @@ translations/ja-JP/content/packages/learn-github-packages/configuring-a-packages translations/ja-JP/content/packages/learn-github-packages/deleting-and-restoring-a-package.md,rendering error translations/ja-JP/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md,rendering error translations/ja-JP/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md,rendering error +translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md,broken liquid tags translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md,broken liquid tags translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md,broken liquid tags translations/ja-JP/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md,broken liquid tags @@ -489,6 +504,7 @@ translations/ja-JP/content/repositories/releasing-projects-on-github/about-relea translations/ja-JP/content/repositories/releasing-projects-on-github/comparing-releases.md,rendering error translations/ja-JP/content/repositories/releasing-projects-on-github/linking-to-releases.md,rendering error translations/ja-JP/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md,rendering error +translations/ja-JP/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md,broken liquid tags translations/ja-JP/content/repositories/working-with-files/using-files/working-with-non-code-files.md,rendering error translations/ja-JP/content/rest/dependabot/index.md,broken liquid tags translations/ja-JP/content/rest/guides/getting-started-with-the-rest-api.md,broken liquid tags @@ -599,6 +615,7 @@ translations/ja-JP/data/reusables/gated-features/secret-scanning-partner.md,rend translations/ja-JP/data/reusables/gated-features/secret-scanning.md,rendering error translations/ja-JP/data/reusables/notifications-v2/custom-notification-types.md,broken liquid tags translations/ja-JP/data/reusables/notifications/shared_state.md,rendering error +translations/ja-JP/data/reusables/notifications/vulnerable-dependency-notification-options.md,broken liquid tags translations/ja-JP/data/reusables/organizations/billing_plans.md,rendering error translations/ja-JP/data/reusables/organizations/github-apps-settings-sidebar.md,rendering error translations/ja-JP/data/reusables/organizations/member-privileges.md,rendering error diff --git a/translations/log/msft-pt-resets.csv b/translations/log/msft-pt-resets.csv index 33b394e90e..f024b8144c 100644 --- a/translations/log/msft-pt-resets.csv +++ b/translations/log/msft-pt-resets.csv @@ -179,6 +179,7 @@ translations/pt-BR/data/graphql/ghes-3.1/graphql_previews.enterprise.yml,file de translations/pt-BR/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main +translations/pt-BR/data/reusables/apps/metadata-permissions.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/billing/per-user-pricing-reference.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/codespaces/about-billing-for-codespaces.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/codespaces/availability.md,file deleted because it no longer exists in main @@ -348,7 +349,7 @@ translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scannin translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags translations/pt-BR/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md,rendering error -translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,broken liquid tags +translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,rendering error translations/pt-BR/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md,broken liquid tags translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md,rendering error translations/pt-BR/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md,rendering error @@ -513,6 +514,7 @@ translations/pt-BR/content/repositories/releasing-projects-on-github/about-relea translations/pt-BR/content/repositories/releasing-projects-on-github/comparing-releases.md,rendering error translations/pt-BR/content/repositories/releasing-projects-on-github/linking-to-releases.md,rendering error translations/pt-BR/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md,rendering error +translations/pt-BR/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md,broken liquid tags translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md,rendering error translations/pt-BR/content/rest/dependabot/index.md,broken liquid tags translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md,broken liquid tags @@ -636,7 +638,7 @@ translations/pt-BR/data/reusables/gated-features/secret-scanning-partner.md,rend translations/pt-BR/data/reusables/gated-features/secret-scanning.md,rendering error translations/pt-BR/data/reusables/identity-and-permissions/ip-allow-lists-enable.md,broken liquid tags translations/pt-BR/data/reusables/notifications-v2/custom-notification-types.md,broken liquid tags -translations/pt-BR/data/reusables/notifications/vulnerable-dependency-notification-options.md,broken liquid tags +translations/pt-BR/data/reusables/notifications/vulnerable-dependency-notification-options.md,rendering error translations/pt-BR/data/reusables/organizations/billing_plans.md,rendering error translations/pt-BR/data/reusables/organizations/github-apps-settings-sidebar.md,rendering error translations/pt-BR/data/reusables/organizations/member-privileges.md,rendering error diff --git a/translations/pt-BR/content/actions/creating-actions/creating-a-javascript-action.md b/translations/pt-BR/content/actions/creating-actions/creating-a-javascript-action.md index 6a56652420..66fc48555f 100644 --- a/translations/pt-BR/content/actions/creating-actions/creating-a-javascript-action.md +++ b/translations/pt-BR/content/actions/creating-actions/creating-a-javascript-action.md @@ -1,5 +1,6 @@ --- title: Creating a JavaScript action +shortTitle: Create a JavaScript action intro: 'In this guide, you''ll learn how to build a JavaScript action using the actions toolkit.' redirect_from: - /articles/creating-a-javascript-action @@ -15,7 +16,6 @@ type: tutorial topics: - Action development - JavaScript -shortTitle: JavaScript action --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md index c32e7dc1d5..9d8f3e75a0 100644 --- a/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md +++ b/translations/pt-BR/content/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-hashicorp-vault.md @@ -1,6 +1,6 @@ --- title: Configuring OpenID Connect in HashiCorp Vault -shortTitle: Configuring OpenID Connect in HashiCorp Vault +shortTitle: OpenID Connect in HashiCorp Vault intro: Use OpenID Connect within your workflows to authenticate with HashiCorp Vault. miniTocMaxHeadingLevel: 3 versions: diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index e2894b8fdd..89ba5d874e 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -1,5 +1,6 @@ --- title: Autoscaling with self-hosted runners +shortTitle: Autoscale self-hosted runners intro: You can automatically scale your self-hosted runners in response to webhook events. versions: fpt: '*' diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index 7463d3c5df..56644b21be 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -1,5 +1,6 @@ --- title: Configuring the self-hosted runner application as a service +shortTitle: Run the runner app as a service intro: You can configure the self-hosted runner application as a service to automatically start the runner application when the machine starts. redirect_from: - /actions/automating-your-workflow-with-github-actions/configuring-the-self-hosted-runner-application-as-a-service @@ -10,7 +11,6 @@ versions: ghec: '*' type: tutorial defaultPlatform: linux -shortTitle: Run runner app on startup --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/translations/pt-BR/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index acf5f26451..6233696e7e 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -1,5 +1,6 @@ --- title: Managing access to self-hosted runners using groups +shortTitle: Manage access with runner groups intro: You can use policies to limit access to self-hosted runners that have been added to an organization or enterprise. redirect_from: - /actions/hosting-your-own-runners/managing-access-to-self-hosted-runners @@ -9,7 +10,6 @@ versions: ghae: '*' ghec: '*' type: tutorial -shortTitle: Using runner groups --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/pt-BR/content/actions/learn-github-actions/finding-and-customizing-actions.md b/translations/pt-BR/content/actions/learn-github-actions/finding-and-customizing-actions.md index 8569d3cf80..26a3fa7743 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -1,6 +1,6 @@ --- title: Finding and customizing actions -shortTitle: Finding and customizing actions +shortTitle: Find and customize actions intro: 'Actions are the building blocks that power your workflow. A workflow can contain actions created by the community, or you can create your own actions directly within your application''s repository. This guide will show you how to discover, use, and customize actions.' redirect_from: - /actions/automating-your-workflow-with-github-actions/using-github-marketplace-actions diff --git a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md index ea6cebc80b..da677ef353 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md @@ -1,6 +1,6 @@ --- title: Understanding GitHub Actions -shortTitle: Understanding GitHub Actions +shortTitle: Understand GitHub Actions intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.' miniTocMaxHeadingLevel: 3 redirect_from: diff --git a/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md b/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md index a1d240e9c0..2984bbaf48 100644 --- a/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md +++ b/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md @@ -1,5 +1,6 @@ --- title: Re-running workflows and jobs +shortTitle: Re-run workflows and jobs intro: 'You can re-run a workflow run{% ifversion re-run-jobs %}, all failed jobs in a workflow run, or specific jobs in a workflow run{% endif %} up to 30 days after its initial run.' permissions: People with write permissions to a repository can re-run workflows in the repository. miniTocMaxHeadingLevel: 3 diff --git a/translations/pt-BR/content/actions/publishing-packages/publishing-docker-images.md b/translations/pt-BR/content/actions/publishing-packages/publishing-docker-images.md index c56906a838..8f521c2664 100644 --- a/translations/pt-BR/content/actions/publishing-packages/publishing-docker-images.md +++ b/translations/pt-BR/content/actions/publishing-packages/publishing-docker-images.md @@ -1,5 +1,6 @@ --- title: Publishing Docker images +shortTitle: Publish Docker images intro: 'You can publish Docker images to a registry, such as Docker Hub or {% data variables.product.prodname_registry %}, as part of your continuous integration (CI) workflow.' redirect_from: - /actions/language-and-framework-guides/publishing-docker-images diff --git a/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md b/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md index 0768413dbc..908764eb17 100644 --- a/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/translations/pt-BR/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -1,5 +1,6 @@ --- title: Publishing Node.js packages +shortTitle: Publish Node.js packages intro: You can publish Node.js packages to a registry as part of your continuous integration (CI) workflow. redirect_from: - /actions/automating-your-workflow-with-github-actions/publishing-nodejs-packages @@ -16,7 +17,6 @@ topics: - Publishing - Node - JavaScript -shortTitle: Node.js packages --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/pt-BR/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/translations/pt-BR/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 62fe7d964c..16defd8a7e 100644 --- a/translations/pt-BR/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/translations/pt-BR/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -1,5 +1,6 @@ --- title: About GitHub-hosted runners +shortTitle: About GitHub-hosted runners intro: '{% data variables.product.prodname_dotcom %} offers hosted virtual machines to run workflows. The virtual machine contains an environment of tools, packages, and settings available for {% data variables.product.prodname_actions %} to use.' redirect_from: - /articles/virtual-environments-for-github-actions @@ -14,7 +15,6 @@ versions: fpt: '*' ghes: '*' ghec: '*' -shortTitle: GitHub-hosted runners --- {% data reusables.actions.enterprise-beta %} diff --git a/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md b/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md index 5d941f42f3..e3251b78a6 100644 --- a/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md +++ b/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -1,11 +1,11 @@ --- title: Using larger runners +shortTitle: 'Larger runners' intro: '{% data variables.product.prodname_dotcom %} offers larger runners with more RAM and CPU.' miniTocMaxHeadingLevel: 3 product: '{% data reusables.gated-features.hosted-runners %}' versions: feature: 'actions-hosted-runners' -shortTitle: Using {% data variables.actions.hosted_runner %}s --- ## Overview of {% data variables.actions.hosted_runner %}s diff --git a/translations/pt-BR/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md b/translations/pt-BR/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md index 77dd9af5bf..ad1fc32d99 100644 --- a/translations/pt-BR/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md +++ b/translations/pt-BR/content/actions/using-workflows/creating-starter-workflows-for-your-organization.md @@ -1,6 +1,6 @@ --- title: Creating starter workflows for your organization -shortTitle: Creating starter workflows +shortTitle: Create starter workflows intro: Learn how you can create starter workflows to help people in your team add new workflows more easily. redirect_from: - /actions/configuring-and-managing-workflows/sharing-workflow-templates-within-your-organization diff --git a/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md b/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md index 432b32ff8a..016cb10829 100644 --- a/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md +++ b/translations/pt-BR/content/actions/using-workflows/reusing-workflows.md @@ -1,6 +1,6 @@ --- title: Reusing workflows -shortTitle: Reusing workflows +shortTitle: Reuse workflows intro: Learn how to avoid duplication when creating a workflow by reusing existing workflows. redirect_from: - /actions/learn-github-actions/reusing-workflows @@ -105,7 +105,7 @@ You can define inputs and secrets, which can be passed from the caller workflow on: workflow_call: inputs: - username: + config-path: required: true type: string secrets: @@ -133,10 +133,10 @@ You can define inputs and secrets, which can be passed from the caller workflow runs-on: ubuntu-latest environment: production steps: - - uses: octo-org/my-action@v1 - with: - username: ${{ inputs.username }} - token: ${{ secrets.envPAT }} + - uses: actions/labeler@v4 + with: + repo-token: ${{ secrets.envPAT }} + configuration-path: ${{ inputs.config-path }} ``` {% endraw %} In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job. @@ -162,7 +162,7 @@ name: Reusable workflow example on: workflow_call: inputs: - username: + config-path: required: true type: string secrets: @@ -170,14 +170,13 @@ on: required: true jobs: - example_job: - name: Pass input and secrets to my-action + triage: runs-on: ubuntu-latest steps: - - uses: octo-org/my-action@v1 - with: - username: ${{ inputs.username }} - token: ${{ secrets.token }} + - uses: actions/labeler@v4 + with: + repo-token: ${{ secrets.token }} + configuration-path: ${{ inputs.config-path }} ``` {% endraw %} @@ -256,7 +255,7 @@ When you call a reusable workflow, you can only use the following keywords in th ### Example caller workflow -This workflow file calls two workflow files. The second of these, `workflow-B.yml` (shown in the [example reusable workflow](#example-reusable-workflow)), is passed an input (`username`) and a secret (`token`). +This workflow file calls two workflow files. The second of these, `workflow-B.yml` (shown in the [example reusable workflow](#example-reusable-workflow)), is passed an input (`config-path`) and a secret (`token`). {% raw %} ```yaml{:copy} @@ -272,11 +271,14 @@ jobs: uses: octo-org/example-repo/.github/workflows/workflow-A.yml@v1 call-workflow-passing-data: + permissions: + contents: read + pull-requests: write uses: octo-org/example-repo/.github/workflows/workflow-B.yml@main with: - username: mona + config-path: .github/labeler.yml secrets: - token: ${{ secrets.TOKEN }} + token: ${{ secrets.GITHUB_TOKEN }} ``` {% endraw %} diff --git a/translations/pt-BR/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md b/translations/pt-BR/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md index 2109206f82..6d56152317 100644 --- a/translations/pt-BR/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md +++ b/translations/pt-BR/content/actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization.md @@ -1,6 +1,6 @@ --- title: 'Sharing workflows, secrets, and runners with your organization' -shortTitle: Sharing workflows with your organization +shortTitle: Share workflows with your organization intro: 'Learn how you can use organization features to collaborate with your team, by sharing starter workflows, secrets, and self-hosted runners.' redirect_from: - /actions/learn-github-actions/sharing-workflows-with-your-organization diff --git a/translations/pt-BR/content/actions/using-workflows/triggering-a-workflow.md b/translations/pt-BR/content/actions/using-workflows/triggering-a-workflow.md index 9c19cc72ff..c0c7429ee7 100644 --- a/translations/pt-BR/content/actions/using-workflows/triggering-a-workflow.md +++ b/translations/pt-BR/content/actions/using-workflows/triggering-a-workflow.md @@ -1,6 +1,6 @@ --- title: Triggering a workflow -shortTitle: Triggering a workflow +shortTitle: Trigger a workflow intro: 'How to automatically trigger {% data variables.product.prodname_actions %} workflows' versions: fpt: '*' diff --git a/translations/pt-BR/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md b/translations/pt-BR/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md index 8eb4e002f8..17af4bb2aa 100644 --- a/translations/pt-BR/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md +++ b/translations/pt-BR/content/codespaces/codespaces-reference/disaster-recovery-for-github-codespaces.md @@ -42,9 +42,9 @@ While {% data variables.product.prodname_github_codespaces %} provides the benef While this option does not configure a development environment for you, it will allow you to make changes to your source code as needed while you wait for the service disruption to resolve. -## Option 4: Use Remote-Containers and Docker for a local containerized environment +## Option 4: Use the Dev Containers extension and Docker for a local containerized environment -If your repository has a `devcontainer.json`, consider using the [Remote-Containers extension](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. +If your repository has a `devcontainer.json`, consider using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in {% data variables.product.prodname_vscode %} to build and attach to a local development container for your repository. The setup time for this option will vary depending on your local specifications and the complexity of your dev container setup. For more information, see "[Developing inside a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-a-git-repository-or-github-pr-in-an-isolated-container-volume)" in the {% data variables.product.prodname_vscode_shortname %} documentation. {% note %} diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md index fe1dcee67c..2465cfe69e 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/codespaces-lifecycle.md @@ -79,4 +79,4 @@ For more information on deleting a codespace, see "[Deleting a codespace](/codes {% data variables.product.prodname_github_codespaces %} is a cloud-based development environment and requires an internet connection. If you lose connection to the internet while working in a codespace, you will not be able to access your codespace. However, any uncommitted changes will be saved. When you have access to an internet connection again, you can connect to your codespace in the exact same state that it was left in. If you have an unstable internet connection, you should commit and push your changes often. -If you know that you will often be working offline, you can use your `devcontainer.json` file with the ["{% data variables.product.prodname_vscode %} Remote - Containers" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) to build and attach to a local development container for your repository. For more information, see [Developing inside a container](https://code.visualstudio.com/docs/remote/containers) in the {% data variables.product.prodname_vscode %} documentation. +If you know that you will often be working offline, you can use your `devcontainer.json` file with the ["Dev Containers" extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for {% data variables.product.prodname_vscode_shortname %} to build and attach to a local development container for your repository. For more information, see [Developing inside a container](https://code.visualstudio.com/docs/remote/containers) in the {% data variables.product.prodname_vscode %} documentation. diff --git a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 4ab4dec53c..9c44b43045 100644 --- a/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/translations/pt-BR/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -27,9 +27,7 @@ Before you can configure prebuilds for your project the following must be true: ## Configuring a prebuild -{% data reusables.repositories.navigate-to-repo %} -{% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% octicon "codespaces" aria-label="The Codespaces icon" %} {% data variables.product.prodname_codespaces %}**. +{% data reusables.codespaces.accessing-prebuild-configuration %} 1. In the "Prebuild configuration" section of the page, click **Set up prebuild**. ![The 'Set up prebuilds' button](/assets/images/help/codespaces/prebuilds-set-up.png) @@ -80,6 +78,12 @@ Before you can configure prebuilds for your project the following must be true: ![The prebuild failure notification setting](/assets/images/help/codespaces/prebuilds-failure-notification-setting.png) +1. Optionally, at the bottom of the page, click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) + + In the "Advanced options" section, if you select **Disable prebuild optimization**, codespaces will be created without a prebuild if the latest prebuild workflow has failed or is currently running. For more information, see "[Troubleshooting prebuilds](/codespaces/troubleshooting/troubleshooting-prebuilds#preventing-out-of-date-prebuilds-being-used)." + 1. Click **Create**. {% data reusables.codespaces.prebuilds-permission-authorization %} diff --git a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md index bd189eecbe..03f5eefc01 100644 --- a/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md +++ b/translations/pt-BR/content/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers.md @@ -126,7 +126,7 @@ You can choose from a list of predefined configurations to create a dev containe Using a predefined configuration is a great idea if you need some additional extensibility. You can also start with a predefined configuration and amend it as needed for your project. For more information about the definitions of predefined dev containers, see the [`devcontainers/images`](https://github.com/devcontainers/images/tree/main/src) repository. -You can add a predefined dev container configuration either while working in a codespace, or while working on a repository locally. To do this in {% data variables.product.prodname_vscode_shortname %} while you are working locally, and not connected to a codespace, you must have the "Remote - Containers" extension installed and enabled. For more information about this extension, see the [{% data variables.product.prodname_vs_marketplace_shortname %}](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). The following procedure describes the process when you are using a codespace. The steps in {% data variables.product.prodname_vscode_shortname %} when you are not connected to a codespace are very similar. +You can add a predefined dev container configuration either while working in a codespace, or while working on a repository locally. To do this in {% data variables.product.prodname_vscode_shortname %} while you are working locally, and not connected to a codespace, you must have the "Dev Containers" extension installed and enabled. For more information about this extension, see the [{% data variables.product.prodname_vs_marketplace_shortname %}](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers). The following procedure describes the process when you are using a codespace. The steps in {% data variables.product.prodname_vscode_shortname %} when you are not connected to a codespace are very similar. {% data reusables.codespaces.command-palette-container %} 1. Click the definition you want to use. diff --git a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index b0d92d091d..e029c962f6 100644 --- a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -30,6 +30,38 @@ If you create a codespace and it does not open: If you still cannot create a codespace for a repository where {% data variables.product.prodname_github_codespaces %} is available, {% data reusables.codespaces.contact-support %} +### Codespace creation fails + +If the creation of a codespace fails, it's likely to be due to a temporary infrastructure issue in the cloud - for example, a problem provisioning a virtual machine for the codespace. A less common reason for failure is if it takes longer than an hour to build the container. In this case, the build is cancelled and codespace creation will fail. + +{% note %} + +**Note:** A codespace that was not successfully created is never going to be usable and should be deleted. For more information, see "[Deleting a codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)." + +{% endnote %} + +If you create a codespace and the creation fails: + +1. Check {% data variables.product.prodname_dotcom %}'s [Status page](https://githubstatus.com) for any active incidents. +1. Go to [your {% data variables.product.prodname_github_codespaces %} page](https://github.com/codespaces), delete the codespace, and create a new codespace. +1. If the container is building, look at the logs that are streaming and make sure the build is not stuck. A container build that takes longer than one hour will be canceled, resulting in a failed creation. + + One common scenario where this could happen is if you have a script running that is prompting for user input and waiting for an answer. If this is the case, remove the interactive prompt so that the build can complete non-interactively. + + {% note %} + + **Note**: To view the logs during a build: + * In the browser, click **View logs.** + + ![Screenshot of the Codespaces web UI with the View logs link emphasized](/assets/images/help/codespaces/web-ui-view-logs.png) + + * In the VS Code desktop application, click **Building codespace** in the "Setting up remote connection" that's displayed. + + ![Screenshot of VS Code with the Building codespace link emphasized](/assets/images/help/codespaces/vs-code-building-codespace.png) + + {% endnote %} +2. If you have a container that takes a long time to build, consider using prebuilds to speed up codespace creations. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)." + ## Deleting codespaces The owner of a codespace has full control over it and only they can delete their codespaces. You cannot delete a codespace created by another user. diff --git a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index 7c4b0ca4e8..45f62d023a 100644 --- a/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -65,6 +65,24 @@ If the `devcontainer.json` configuration file for a prebuild configuration is up If the workflow runs for a prebuild configuration are failing, you can temporarily disable the prebuild configuration while you investigate. For more information, see "[Managing prebuilds](/codespaces/prebuilding-your-codespaces/managing-prebuilds#disabling-a-prebuild-configuration)." +### Preventing out-of-date prebuilds being used + +By default, if the latest prebuild workflow has failed, then a previous prebuild for the same combination of repository, branch, and `devcontainer.json` configuration file will be used to create new codespaces. This behavior is called prebuild optimization. + +We recommend keeping prebuild optimization enabled, because it helps ensure that codespaces can still be created quickly if an up-to-date prebuild is not available. However, as a repository administrator, you can disable prebuild optimization if you run into problems with prebuilt codespaces being behind the current state of the branch. If you disable prebuild optimization, codespaces for the relevant combination of repository, branch, and `devcontainer.json` file will be created without a prebuild if the latest prebuild workflow has failed or is currently running. + +{% data reusables.codespaces.accessing-prebuild-configuration %} +1. To the right of the affected prebuild configuration, select the ellipsis (**...**), then click **Edit**. + + ![Screenshot of a list of prebuilds, with "Edit" highlighted](/assets/images/help/codespaces/edit-prebuild-configuration.png) +1. Scroll to the bottom of the "Edit configuration" page and click **Show advanced options**. + + ![Screenshot of the prebuild configuration page, with "Show advanced options" highlighted](/assets/images/help/codespaces/show-advanced-options.png) +1. If you're sure you want to disable the default setting, select **Disable prebuild optimization**. + + ![Screenshot of the advanced option section and the "disable prebuild optmization" setting](/assets/images/help/codespaces/disable-prebuild-optimization.png) +1. To save your change, click **Update**. + ## Further reading - "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds)" diff --git a/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 5f0436ff5f..5e9fa6ecc4 100644 --- a/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -489,7 +489,7 @@ The following example will add a draft issue to your project. Replace `PROJECT_I curl --request POST \ --url https://api.github.com/graphql \ --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: \"PROJECT_ID\" title: \"TITLE\" body: \"BODY\"}) {projectItem {id}}}"}' ``` {% endcurl %} diff --git a/translations/pt-BR/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/translations/pt-BR/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md index 55090190af..358b0e8a2b 100644 --- a/translations/pt-BR/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md +++ b/translations/pt-BR/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -1,6 +1,6 @@ --- -title: Sobre arquivos grandes no GitHub -intro: '{% data variables.product.product_name %} limita o tamanho dos arquivos que você pode rastrear em repositórios do Git regulares. Aprenda a rastrear ou remover arquivos que estão além do limite.' +title: About large files on GitHub +intro: '{% data variables.product.product_name %} limits the size of files you can track in regular Git repositories. Learn how to track or remove files that are beyond the limit.' redirect_from: - /articles/distributing-large-binaries - /github/managing-large-files/distributing-large-binaries @@ -22,88 +22,85 @@ versions: ghae: '*' ghec: '*' shortTitle: Large files -ms.openlocfilehash: c9910f669b13c0c2bc4a8517ac6b33476b23b475 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146331645' --- -## Sobre limites de tamanho em {% data variables.product.product_name %} -{% ifversion fpt or ghec %} O {% data variables.product.product_name %} tenta fornecer amplo armazenamento para todos os repositórios Git, embora existam limites rígidos para tamanhos de arquivo e de repositório. Para garantir o desempenho e confiabilidade aos nossos usuários, monitoramos ativamente os sinais da saúde geral do repositório. A saúde do repositório é uma função de vários fatores de interação, incluindo tamanho, frequência de commit, conteúdo e estrutura. +## About size limits on {% data variables.product.product_name %} -### Limites de tamanho de arquivo +{% ifversion fpt or ghec %} +{% data variables.product.product_name %} tries to provide abundant storage for all Git repositories, although there are hard limits for file and repository sizes. To ensure performance and reliability for our users, we actively monitor signals of overall repository health. Repository health is a function of various interacting factors, including size, commit frequency, contents, and structure. + +### File size limits {% endif %} -{% data variables.product.product_name %} limita o tamanho dos arquivos permitidos nos repositórios. Se você tentar adicionar ou atualizar um arquivo maior do que {% data variables.large_files.warning_size %}, você receberá um aviso do Git. As alterações ainda serão carregadas no seu repositório com sucesso, mas você pode considerar remover o commit para minimizar o impacto no desempenho. Para obter mais informações, confira "[Como remover arquivos do histórico de um repositório](#removing-files-from-a-repositorys-history)". +{% data variables.product.product_name %} limits the size of files allowed in repositories. If you attempt to add or update a file that is larger than {% data variables.large_files.warning_size %}, you will receive a warning from Git. The changes will still successfully push to your repository, but you can consider removing the commit to minimize performance impact. For more information, see "[Removing files from a repository's history](#removing-files-from-a-repositorys-history)." {% note %} -**Observação:** se você adicionar um arquivo a um repositório por meio de um navegador, o arquivo não poderá ser maior que {% data variables.large_files.max_github_browser_size %}. Para obter mais informações, confira "[Como adicionar um arquivo a um repositório](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)". +**Note:** If you add a file to a repository via a browser, the file can be no larger than {% data variables.large_files.max_github_browser_size %}. For more information, see "[Adding a file to a repository](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." {% endnote %} -{% ifversion ghes %}Por padrão, o {% endif %}{% data variables.product.product_name %} bloqueia os pushes que excedem {% data variables.large_files.max_github_size %}. {% ifversion ghes %}No entanto, um administrador do site pode configurar um limite diferente para o {% data variables.product.product_location %}. Para obter mais informações, confira "[Como definir limites de push do Git](/enterprise/admin/guides/installation/setting-git-push-limits)".{% endif %} +{% ifversion ghes %}By default, {% endif %}{% data variables.product.product_name %} blocks files larger than {% data variables.large_files.max_github_size %}. {% ifversion ghes %}However, a site administrator can configure a different limit for {% data variables.product.product_location %}. For more information, see "[Setting Git push limits](/enterprise/admin/guides/installation/setting-git-push-limits)."{% endif %} -Para rastrear arquivos além desse limite, você deverá usar {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}). Para obter mais informações, confira "[Sobre o {% data variables.large_files.product_name_long %}](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)". +To track files beyond this limit, you must use {% data variables.large_files.product_name_long %} ({% data variables.large_files.product_name_short %}). For more information, see "[About {% data variables.large_files.product_name_long %}](/repositories/working-with-files/managing-large-files/about-git-large-file-storage)." -Se precisar distribuir arquivos grandes dentro do seu repositório, você poderá criar versões no {% data variables.product.product_location %} em vez de rastrear os arquivos. Para obter mais informações, confira "[Como distribuir binários grandes](#distributing-large-binaries)". +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %} instead of tracking the files. For more information, see "[Distributing large binaries](#distributing-large-binaries)." -O Git não é projetado para lidar com arquivos SQL grandes. Para compartilhar bancos de dados grandes com outros desenvolvedores, recomendamos usar o [Dropbox](https://www.dropbox.com/). +Git is not designed to handle large SQL files. To share large databases with other developers, we recommend using [Dropbox](https://www.dropbox.com/). -{% ifversion fpt or ghec %} -### Limites de tamanho do repositório +{% ifversion fpt or ghec or ghae %} +### Repository size limits -Recomendamos que repositórios permaneçam pequenos, idealmente inferior a 1 GB, e o tamanho inferior a 1 GB é altamente recomendado. Os repositórios menores são mais rápidos de clonar e são mais fáceis de trabalhar com e manter. Se o seu repositório impactar excessivamente a nossa infraestrutura, você pode receber um e-mail do {% data variables.contact.github_support %} pedindo para tomar medidas corretivas. Tentamos ser flexíveis, especialmente com grandes projetos que têm muitos colaboradores e trabalharemos com você para encontrar uma resolução sempre que possível. Você pode impedir que seu repositório afete nossa infraestrutura gerenciando efetivamente o tamanho e a saúde geral do seu repositório. Encontre orientações e uma ferramenta para análise de repositório no repositório [`github/git-sizer`](https://github.com/github/git-sizer). +We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. {% ifversion ghae %}The maximum size for a repository on {% data variables.product.product_name %} is 100 GB. {% endif %}Smaller repositories are faster to clone and easier to work with and maintain. If your repository excessively impacts our infrastructure, you might receive an email from {% data variables.contact.github_support %} asking you to take corrective action. We try to be flexible, especially with large projects that have many collaborators, and will work with you to find a resolution whenever possible. You can prevent your repository from impacting our infrastructure by effectively managing your repository's size and overall health. You can find advice and a tool for repository analysis in the [`github/git-sizer`](https://github.com/github/git-sizer) repository. -As dependências externas podem fazer com que os repositórios do Git se tornem muito grandes. Para evitar o preenchimento de um repositório com dependências externas, recomendamos o uso de um gerenciador de pacotes. Entre os gerenciadores de pacotes populares para linguagens comuns estão o [Bundler](http://bundler.io/), o [Gerenciador de Pacotes do Node](http://npmjs.org/) e o [Maven](http://maven.apache.org/). Estes gerenciadores de pacotes são compatíveis com o uso direto dos repositórios do Git. Portanto, você não precisa de fontes pré-empacotadas. +External dependencies can cause Git repositories to become very large. To avoid filling a repository with external dependencies, we recommend you use a package manager. Popular package managers for common languages include [Bundler](http://bundler.io/), [Node's Package Manager](http://npmjs.org/), and [Maven](http://maven.apache.org/). These package managers support using Git repositories directly, so you don't need pre-packaged sources. -O Git não foi projetado para servir como ferramenta de backup. No entanto, há muitas soluções especificamente projetadas para executar backups, como o [Arq](https://www.arqbackup.com/), o [Carbonite](http://www.carbonite.com/) e o [CrashPlan](https://www.crashplan.com/en-us/). +Git is not designed to serve as a backup tool. However, there are many solutions specifically designed for performing backups, such as [Arq](https://www.arqbackup.com/), [Carbonite](http://www.carbonite.com/), and [CrashPlan](https://www.crashplan.com/en-us/). {% endif %} -## Remover arquivos do histórico do repositório +## Removing files from a repository's history {% warning %} -**Aviso**: estes procedimentos removem definitivamente os arquivos do repositório no computador e no {% data variables.product.product_location %}. Se o arquivo for importante, faça uma cópia de backup local em um diretório fora do repositório. +**Warning**: These procedures will permanently remove files from the repository on your computer and {% data variables.product.product_location %}. If the file is important, make a local backup copy in a directory outside of the repository. {% endwarning %} -### Remover um arquivo adicionado ao commit não processado mais recente +### Removing a file added in the most recent unpushed commit -Se o arquivo foi adicionado ao commit mais recente e ainda não foi processado no {% data variables.product.product_location %}, você poderá excluir o arquivo e corrigir o commit: +If the file was added with your most recent commit, and you have not pushed to {% data variables.product.product_location %}, you can delete the file and amend the commit: -{% data reusables.command_line.open_the_multi_os_terminal %} {% data reusables.command_line.switching_directories_procedural %} -3. Para remover o arquivo, insira `git rm --cached`: +{% data reusables.command_line.open_the_multi_os_terminal %} +{% data reusables.command_line.switching_directories_procedural %} +3. To remove the file, enter `git rm --cached`: ```shell - $ git rm --cached giant_file + $ git rm --cached GIANT_FILE # Stage our giant file for removal, but leave it on disk ``` -4. Faça commit dessa alteração usando `--amend -CHEAD`: +4. Commit this change using `--amend -CHEAD`: ```shell $ git commit --amend -CHEAD # Amend the previous commit with your change # Simply making a new commit won't work, as you need # to remove the file from the unpushed history as well ``` -5. Faça push dos commits para {% data variables.product.product_location %}: +5. Push your commits to {% data variables.product.product_location %}: ```shell $ git push # Push our rewritten, smaller commit ``` -### Remover um arquivo adicionado em um commit anterior +### Removing a file that was added in an earlier commit -Se você adicionou um arquivo em um commit anterior, você deverá removê-lo do histórico do repositório. Para remover arquivos do histórico do repositório, use o BFG Repo-Cleaner ou o comando `git filter-branch`. Para obter mais informações, confira "[Como remover dados confidenciais de um repositório](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)". +If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)." -## Distribuir binários grandes +## Distributing large binaries -Se você precisar distribuir arquivos grandes dentro do seu repositório, você poderá criar versões no {% data variables.product.product_location %}. As versões permitem que você empacote software, notas de versão e links para arquivos binários para que outras pessoas possam usar. Para obter mais informações, acesse "[Sobre as versões](/github/administering-a-repository/about-releases)". +If you need to distribute large files within your repository, you can create releases on {% data variables.product.product_location %}. Releases allow you to package software, release notes, and links to binary files, for other people to use. For more information, visit "[About releases](/github/administering-a-repository/about-releases)." {% ifversion fpt or ghec %} -Não limitamos o tamanho total dos arquivos binários na versão ou a banda larga usada para entregá-los. No entanto, cada arquivo deve ser menor que {% data variables.large_files.max_lfs_size %}. +We don't limit the total size of the binary files in the release or the bandwidth used to deliver them. However, each individual file must be smaller than {% data variables.large_files.max_lfs_size %}. {% endif %} diff --git a/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md b/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md index ffa76e3719..a369469433 100644 --- a/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md +++ b/translations/pt-BR/content/rest/overview/permissions-required-for-github-apps.md @@ -19,11 +19,12 @@ shortTitle: GitHub App permissions {% data variables.product.prodname_github_apps %} are created with a set of permissions. Permissions define what resources the {% data variables.product.prodname_github_app %} can access via the API. For more information, see "[Setting permissions for GitHub Apps](/apps/building-github-apps/setting-permissions-for-github-apps/)." -## Metadata permissions + +## Metadata -GitHub Apps have the `Read-only` metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. +GitHub Apps have the **Read-only** metadata permission by default. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information. -{% data reusables.apps.metadata-permissions %} +If you set the metadata permission to **No access** and select a permission that requires repository access, GitHub will override your selection and set the metadata permission back to **Read-only**. To set the metadata permission to **No access**, you must set all permissions that require repository access to **No access** first. - [`GET /`](/rest#root-endpoint) - [`GET /codes_of_conduct`](/rest/reference/codes-of-conduct#get-all-codes-of-conduct) @@ -96,9 +97,6 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe - [`GET /gitignore/templates`](/rest/reference/gitignore#get-all-gitignore-templates) - [`GET /gitignore/templates/:key`](/rest/reference/gitignore#get-a-gitignore-template) -### Keys -- [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) - ### Organization members - [`GET /orgs/:org/members`](/rest/reference/orgs#list-organization-members) - [`GET /orgs/:org/members/:username`](/rest/reference/orgs#check-organization-membership-for-a-user) @@ -114,856 +112,903 @@ GitHub Apps have the `Read-only` metadata permission by default. The metadata pe - [`GET /search/topics`](/rest/reference/search#search-topics) - [`GET /search/users`](/rest/reference/search#search-users) -{% ifversion fpt or ghes or ghec %} -## Permission on "actions" +### SSH keys +- [`GET /users/:username/keys`](/rest/reference/users#list-public-keys-for-a-user) -- [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) -- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (:write) -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (:read) +{% ifversion fpt or ghes or ghec %} + +## Actions + +- [`GET /repos/:owner/:repo/actions/artifacts`](/rest/reference/actions#list-artifacts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (read) +- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (write) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (read) {% ifversion actions-cache-management -%} -- [`GET /repos/:owner/:repo/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-a-repository) (read) {% endif -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (read) {% ifversion fpt or ghec -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/approve`](/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/approve`](/rest/reference/actions#approve-a-workflow-run-for-a-fork-pull-request) (write) {% endif -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (:read) -- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (:write) -- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (:read) -- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (:read) -- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (:write) -- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (:write) -- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (:read) -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (:read) -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (read) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (write) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (read) +- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (write) +- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (read) {% endif %} -## Permission on "administration" + +## Administration -- [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (:write) -- [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (:write) -- [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (:write) -- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (:read) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (:write) -- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (:write) -- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (:write) +- [`POST /orgs/:org/repos`](/rest/reference/repos#create-an-organization-repository) (write) +- [`PATCH /repos/:owner/:repo`](/rest/reference/repos#update-a-repository) (write) +- [`DELETE /repos/:owner/:repo`](/rest/reference/repos#delete-a-repository) (write) +- [`GET /repos/:owner/:repo/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-a-repository) (read) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-a-repository) (read) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository) (write) +- [`GET /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-a-repository) (read) +- [`POST /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository) (write) +- [`PUT /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-a-repository) (write) {% ifversion fpt or ghec or ghes -%} -- [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (:write) -- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (:write) +- [`POST /repos/:owner/:repo/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-a-repository) (write) +- [`POST /repos/:owner/:repo/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (:write) +- [`PUT /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#enable-automated-security-fixes) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#disable-automated-security-fixes) (:write) +- [`DELETE /repos/:owner/:repo/automated-security-fixes`](/rest/reference/repos#disable-automated-security-fixes) (write) {% endif -%} -- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (:write) +- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (write) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-a-repository) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) (:write) +- [`PUT /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) (:write) +- [`DELETE /repos/:owner/:repo/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-a-repository) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (:write) +- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (write) {% endif -%} {% ifversion ghes > 3.3 -%} -- [`GET /repos/:owner/:repo/replicas/caches`](/rest/reference/repos#list-repository-cache-replication-status) (:read) +- [`GET /repos/:owner/:repo/replicas/caches`](/rest/reference/repos#list-repository-cache-replication-status) (read) {% endif -%} -- [`PUT /repos/:owner/:repo/topics`](/rest/reference/repos#replace-all-repository-topics) (:write) -- [`POST /repos/:owner/:repo/transfer`](/rest/reference/repos#transfer-a-repository) (:write) +- [`PUT /repos/:owner/:repo/topics`](/rest/reference/repos#replace-all-repository-topics) (write) +- [`POST /repos/:owner/:repo/transfer`](/rest/reference/repos#transfer-a-repository) (write) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (:read) +- [`GET /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (:write) +- [`PUT /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#enable-vulnerability-alerts) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#disable-vulnerability-alerts) (:write) +- [`DELETE /repos/:owner/:repo/vulnerability-alerts`](/rest/reference/repos#disable-vulnerability-alerts) (write) {% endif -%} -- [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#accept-a-repository-invitation) (:write) -- [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#decline-a-repository-invitation) (:write) +- [`PATCH /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#accept-a-repository-invitation) (write) +- [`DELETE /user/repository_invitations/:invitation_id`](/rest/reference/collaborators#decline-a-repository-invitation) (write) ### Branches -- [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#get-branch-protection) (:read) -- [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#update-branch-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#delete-branch-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#get-admin-branch-protection) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#set-admin-branch-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#delete-admin-branch-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#get-pull-request-review-protection) (:read) -- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#update-pull-request-review-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#delete-pull-request-review-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#get-commit-signature-protection) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#create-commit-signature-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#delete-commit-signature-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#get-status-checks-protection) (:read) -- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#update-status-check-protection) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#remove-status-check-protection) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#get-all-status-check-contexts) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#add-status-check-contexts) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#set-status-check-contexts) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#remove-status-check-contexts) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#get-access-restrictions) (:read) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#delete-access-restrictions) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#add-team-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#set-team-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#remove-team-access-restrictions) (:write) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/repos#list-users-with-access-to-the-protected-branch) (:read) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#add-user-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#set-user-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#remove-user-access-restrictions) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (:write) +- [`GET /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#get-branch-protection) (read) +- [`PUT /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#update-branch-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection`](/rest/reference/branches#delete-branch-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#get-admin-branch-protection) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#set-admin-branch-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/enforce_admins`](/rest/reference/branches#delete-admin-branch-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#get-pull-request-review-protection) (read) +- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#update-pull-request-review-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews`](/rest/reference/branches#delete-pull-request-review-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#get-commit-signature-protection) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#create-commit-signature-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/rest/reference/branches#delete-commit-signature-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#get-status-checks-protection) (read) +- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#update-status-check-protection) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/rest/reference/branches#remove-status-check-protection) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#get-all-status-check-contexts) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#add-status-check-contexts) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#set-status-check-contexts) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/rest/reference/branches#remove-status-check-contexts) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#get-access-restrictions) (read) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions`](/rest/reference/branches#delete-access-restrictions) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/repos#list-teams-with-access-to-the-protected-branch) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#add-team-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#set-team-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/teams`](/rest/reference/branches#remove-team-access-restrictions) (write) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/repos#list-users-with-access-to-the-protected-branch) (read) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#add-user-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#set-user-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/users`](/rest/reference/branches#remove-user-access-restrictions) (write) +- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (write) ### Collaborators -- [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#add-a-repository-collaborator) (:write) -- [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#remove-a-repository-collaborator) (:write) +- [`PUT /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#add-a-repository-collaborator) (write) +- [`DELETE /repos/:owner/:repo/collaborators/:username`](/rest/reference/collaborators#remove-a-repository-collaborator) (write) ### Invitations -- [`GET /repos/:owner/:repo/invitations`](/rest/reference/collaborators#list-repository-invitations) (:read) -- [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#update-a-repository-invitation) (:write) -- [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#delete-a-repository-invitation) (:write) +- [`GET /repos/:owner/:repo/invitations`](/rest/reference/collaborators#list-repository-invitations) (read) +- [`PATCH /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#update-a-repository-invitation) (write) +- [`DELETE /repos/:owner/:repo/invitations/:invitation_id`](/rest/reference/collaborators#delete-a-repository-invitation) (write) -### Keys -- [`GET /repos/:owner/:repo/keys`](/rest/reference/deployments#list-deploy-keys) (:read) -- [`POST /repos/:owner/:repo/keys`](/rest/reference/deployments#create-a-deploy-key) (:write) -- [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#get-a-deploy-key) (:read) -- [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#delete-a-deploy-key) (:write) +### SSH keys +- [`GET /repos/:owner/:repo/keys`](/rest/reference/deployments#list-deploy-keys) (read) +- [`POST /repos/:owner/:repo/keys`](/rest/reference/deployments#create-a-deploy-key) (write) +- [`GET /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#get-a-deploy-key) (read) +- [`DELETE /repos/:owner/:repo/keys/:key_id`](/rest/reference/deployments#delete-a-deploy-key) (write) ### Teams -- [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (:read) -- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:write) -- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) +- [`GET /repos/:owner/:repo/teams`](/rest/reference/repos#list-repository-teams) (read) +- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (write) +- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (write) {% ifversion fpt or ghec %} ### Traffic -- [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repository-metrics#get-repository-clones) (:read) -- [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repository-metrics#get-top-referral-paths) (:read) -- [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repository-metrics#get-top-referral-sources) (:read) -- [`GET /repos/:owner/:repo/traffic/views`](/rest/reference/repository-metrics#get-page-views) (:read) +- [`GET /repos/:owner/:repo/traffic/clones`](/rest/reference/repository-metrics#get-repository-clones) (read) +- [`GET /repos/:owner/:repo/traffic/popular/paths`](/rest/reference/repository-metrics#get-top-referral-paths) (read) +- [`GET /repos/:owner/:repo/traffic/popular/referrers`](/rest/reference/repository-metrics#get-top-referral-sources) (read) +- [`GET /repos/:owner/:repo/traffic/views`](/rest/reference/repository-metrics#get-page-views) (read) {% endif %} {% ifversion fpt or ghec %} -## Permission on "blocking" + +## Blocking users -- [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (:read) -- [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (:read) -- [`PUT /user/blocks/:username`](/rest/reference/users#block-a-user) (:write) -- [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (:write) +- [`GET /user/blocks`](/rest/reference/users#list-users-blocked-by-the-authenticated-user) (read) +- [`GET /user/blocks/:username`](/rest/reference/users#check-if-a-user-is-blocked-by-the-authenticated-user) (read) +- [`PUT /user/blocks/:username`](/rest/reference/users#block-a-user) (write) +- [`DELETE /user/blocks/:username`](/rest/reference/users#unblock-a-user) (write) {% endif %} -## Permission on "checks" + +## Checks -- [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (:write) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) -- [`PATCH /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#update-a-check-run) (:write) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (:read) -- [`POST /repos/:owner/:repo/check-suites`](/rest/reference/checks#create-a-check-suite) (:write) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (:read) -- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (:write) -- [`PATCH /repos/:owner/:repo/check-suites/preferences`](/rest/reference/checks#update-repository-preferences-for-check-suites) (:write) -- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) +- [`POST /repos/:owner/:repo/check-runs`](/rest/reference/checks#create-a-check-run) (write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (read) +- [`PATCH /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#update-a-check-run) (write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (read) +- [`POST /repos/:owner/:repo/check-suites`](/rest/reference/checks#create-a-check-suite) (write) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (read) +- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (write) +- [`PATCH /repos/:owner/:repo/check-suites/preferences`](/rest/reference/checks#update-repository-preferences-for-check-suites) (write) +- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (read) + + +## Code scanning alerts + +- [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (read) +- [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (write) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (read) +{% endif -%} +- [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (read) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (read) +{% endif -%} +{% ifversion fpt or ghec or ghes -%} +- [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (write) +{% endif -%} +- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (write) +{% ifversion fpt or ghec or ghes or ghae -%} +- [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (read) +{% endif -%} +{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 -%} +- [`GET /orgs/:org/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-by-organization) (read) +{% endif -%} {% ifversion fpt or ghec %} -## Permission on "codespaces" + +## Codespaces - [`GET /repos/:owner/:repo/codespaces/machines`](/rest/reference/codespaces#list-available-machine-types-for-a-repository) {% endif %} -## Permission on "contents" -- [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (:read) + +## Commit statuses + +- [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) (read) +- [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/commits#list-commit-statuses-for-a-reference) (read) +- [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/commits#create-a-commit-status) (write) + + +## Contents + +- [`GET /repos/:owner/:repo/:archive_format/:ref`](/rest/reference/repos#download-a-repository-archive) (read) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (:read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#get-an-artifact) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (:write) +- [`DELETE /repos/:owner/:repo/actions/artifacts/:artifact_id`](/rest/reference/actions#delete-an-artifact) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (:read) +- [`GET /repos/:owner/:repo/actions/artifacts/:artifact_id/zip`](/rest/reference/actions#download-an-artifact) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id`](/rest/reference/actions#get-a-job-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/jobs/:job_id/logs`](/rest/reference/actions#download-job-logs-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (:read) +- [`GET /repos/:owner/:repo/actions/runs`](/rest/reference/actions#list-workflow-runs-for-a-repository) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id`](/rest/reference/actions#get-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/artifacts`](/rest/reference/actions#list-workflow-run-artifacts) (read) {% endif -%} {% ifversion fpt -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/cancel`](/rest/reference/actions#cancel-a-workflow-run) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/jobs`](/rest/reference/actions#list-jobs-for-a-workflow-run) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (:read) +- [`GET /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#download-workflow-run-logs) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (:write) +- [`DELETE /repos/:owner/:repo/actions/runs/:run_id/logs`](/rest/reference/actions#delete-workflow-run-logs) (write) {% endif -%} {% ifversion fpt -%} -- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (:write) +- [`POST /repos/:owner/:repo/actions/runs/:run_id/rerun`](/rest/reference/actions#re-run-a-workflow) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:write) +- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#get-a-repository-secret) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#get-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#create-or-update-a-repository-secret) (:write) +- [`PUT /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#create-or-update-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#delete-a-repository-secret) (:write) +- [`DELETE /repos/:owner/:repo/actions/secrets/:name`](/rest/reference/actions#delete-a-repository-secret) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (:read) +- [`GET /repos/:owner/:repo/actions/workflows`](/rest/reference/actions#list-repository-workflows) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (:read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id`](/rest/reference/actions#get-a-workflow) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (:read) +- [`GET /repos/:owner/:repo/actions/workflows/:workflow_id/runs`](/rest/reference/actions#list-workflow-runs) (read) {% endif -%} -- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (:read) -- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (:read) -- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (:read) -- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (:write) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id`](/rest/reference/checks#get-a-check-run) (read) +- [`GET /repos/:owner/:repo/check-runs/:check_run_id/annotations`](/rest/reference/checks#list-check-run-annotations) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id`](/rest/reference/checks#get-a-check-suite) (read) +- [`GET /repos/:owner/:repo/check-suites/:check_suite_id/check-runs`](/rest/reference/checks#list-check-runs-in-a-check-suite) (read) +- [`POST /repos/:owner/:repo/check-suites/:check_suite_id/rerequest`](/rest/reference/checks#rerequest-a-check-suite) (write) {% ifversion codeowners-errors %} -- [`GET /repos/:owner/:repo/codeowners/errors`](/rest/reference/repos#list-codeowners-errors) (:read) +- [`GET /repos/:owner/:repo/codeowners/errors`](/rest/reference/repos#list-codeowners-errors) (read) {% endif %} -- [`GET /repos/:owner/:repo/commits`](/rest/reference/commits#list-commits) (:read) -- [`GET /repos/:owner/:repo/commits/:sha`](/rest/reference/commits#get-a-commit) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (:read) -- [`GET /repos/:owner/:repo/community/code_of_conduct`](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/compare/:base...:head`](/rest/reference/commits#compare-two-commits) (:read) -- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) -- [`POST /repos/:owner/:repo/dispatches`](/rest/reference/repos#create-a-repository-dispatch-event) (:write) -- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (:read) -- [`POST /repos/:owner/:repo/merges`](/rest/reference/branches#merge-a-branch) (:write) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (:read) +- [`GET /repos/:owner/:repo/commits`](/rest/reference/commits#list-commits) (read) +- [`GET /repos/:owner/:repo/commits/:sha`](/rest/reference/commits#get-a-commit) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-runs`](/rest/reference/checks#list-check-runs-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/commits/:sha/check-suites`](/rest/reference/checks#list-check-suites-for-a-git-reference) (read) +- [`GET /repos/:owner/:repo/community/code_of_conduct`](/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository) (read) +- [`GET /repos/:owner/:repo/compare/:base...:head`](/rest/reference/commits#compare-two-commits) (read) +- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (read) +- [`POST /repos/:owner/:repo/dispatches`](/rest/reference/repos#create-a-repository-dispatch-event) (write) +- [`POST /repos/:owner/:repo/forks`](/rest/reference/repos#create-a-fork) (read) +- [`POST /repos/:owner/:repo/merges`](/rest/reference/branches#merge-a-branch) (write) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#merge-a-pull-request) (write) +- [`GET /repos/:owner/:repo/readme(?:/(.*))?`](/rest/reference/repos#get-a-repository-readme) (read) ### Branches -- [`GET /repos/:owner/:repo/branches`](/rest/reference/branches#list-branches) (:read) -- [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/branches#get-a-branch) (:read) -- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#add-app-access-restrictions) (:write) -- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#set-app-access-restrictions) (:write) -- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#remove-user-access-restrictions) (:write) -- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (:write) +- [`GET /repos/:owner/:repo/branches`](/rest/reference/branches#list-branches) (read) +- [`GET /repos/:owner/:repo/branches/:branch`](/rest/reference/branches#get-a-branch) (read) +- [`GET /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/repos#list-apps-with-access-to-the-protected-branch) (write) +- [`POST /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#add-app-access-restrictions) (write) +- [`PUT /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#set-app-access-restrictions) (write) +- [`DELETE /repos/:owner/:repo/branches/:branch/protection/restrictions/apps`](/rest/reference/branches#remove-user-access-restrictions) (write) +- [`POST /repos/:owner/:repo/branches/:branch/rename`](/rest/reference/branches#rename-a-branch) (write) ### Commit comments -- [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#update-a-commit-comment) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#delete-a-commit-comment) (:write) -- [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (:write) -- [`POST /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/commits#create-a-commit-comment) (:write) +- [`PATCH /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#update-a-commit-comment) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id`](/rest/reference/commits#delete-a-commit-comment) (write) +- [`POST /repos/:owner/:repo/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-commit-comment) (write) +- [`POST /repos/:owner/:repo/commits/:sha/comments`](/rest/reference/commits#create-a-commit-comment) (write) ### Git -- [`POST /repos/:owner/:repo/git/blobs`](/rest/reference/git#create-a-blob) (:write) -- [`GET /repos/:owner/:repo/git/blobs/:sha`](/rest/reference/git#get-a-blob) (:read) -- [`POST /repos/:owner/:repo/git/commits`](/rest/reference/git#create-a-commit) (:write) -- [`GET /repos/:owner/:repo/git/commits/:commit_id`](/rest/reference/git#get-a-commit) (:read) -- [`POST /repos/:owner/:repo/git/refs`](/rest/reference/git#create-a-reference) (:write) -- [`GET /repos/:owner/:repo/git/ref/:ref`](/rest/reference/git#get-a-reference) (:read) -- [`GET /repos/:owner/:repo/git/matching-refs/:ref`](/rest/reference/git#list-matching-references) (:read) -- [`PATCH /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#update-a-reference) (:write) -- [`DELETE /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#delete-a-reference) (:write) -- [`POST /repos/:owner/:repo/git/tags`](/rest/reference/git#create-a-tag-object) (:write) -- [`GET /repos/:owner/:repo/git/tags/:tag_id`](/rest/reference/git#get-a-tag) (:read) -- [`POST /repos/:owner/:repo/git/trees`](/rest/reference/git#create-a-tree) (:write) -- [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (:read) +- [`POST /repos/:owner/:repo/git/blobs`](/rest/reference/git#create-a-blob) (write) +- [`GET /repos/:owner/:repo/git/blobs/:sha`](/rest/reference/git#get-a-blob) (read) +- [`POST /repos/:owner/:repo/git/commits`](/rest/reference/git#create-a-commit) (write) +- [`GET /repos/:owner/:repo/git/commits/:commit_id`](/rest/reference/git#get-a-commit) (read) +- [`POST /repos/:owner/:repo/git/refs`](/rest/reference/git#create-a-reference) (write) +- [`GET /repos/:owner/:repo/git/ref/:ref`](/rest/reference/git#get-a-reference) (read) +- [`GET /repos/:owner/:repo/git/matching-refs/:ref`](/rest/reference/git#list-matching-references) (read) +- [`PATCH /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#update-a-reference) (write) +- [`DELETE /repos/:owner/:repo/git/refs/:ref`](/rest/reference/git#delete-a-reference) (write) +- [`POST /repos/:owner/:repo/git/tags`](/rest/reference/git#create-a-tag-object) (write) +- [`GET /repos/:owner/:repo/git/tags/:tag_id`](/rest/reference/git#get-a-tag) (read) +- [`POST /repos/:owner/:repo/git/trees`](/rest/reference/git#create-a-tree) (write) +- [`GET /repos/:owner/:repo/git/trees/:sha`](/rest/reference/git#get-a-tree) (read) {% ifversion fpt or ghec %} ### Import -- [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (:read) -- [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (:write) -- [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (:write) -- [`DELETE /repos/:owner/:repo/import`](/rest/reference/migrations#cancel-an-import) (:write) -- [`GET /repos/:owner/:repo/import/authors`](/rest/reference/migrations#get-commit-authors) (:read) -- [`PATCH /repos/:owner/:repo/import/authors/:author_id`](/rest/reference/migrations#map-a-commit-author) (:write) -- [`GET /repos/:owner/:repo/import/large_files`](/rest/reference/migrations#get-large-files) (:read) -- [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (:write) +- [`GET /repos/:owner/:repo/import`](/rest/reference/migrations#get-an-import-status) (read) +- [`PUT /repos/:owner/:repo/import`](/rest/reference/migrations#start-an-import) (write) +- [`PATCH /repos/:owner/:repo/import`](/rest/reference/migrations#update-an-import) (write) +- [`DELETE /repos/:owner/:repo/import`](/rest/reference/migrations#cancel-an-import) (write) +- [`GET /repos/:owner/:repo/import/authors`](/rest/reference/migrations#get-commit-authors) (read) +- [`PATCH /repos/:owner/:repo/import/authors/:author_id`](/rest/reference/migrations#map-a-commit-author) (write) +- [`GET /repos/:owner/:repo/import/large_files`](/rest/reference/migrations#get-large-files) (read) +- [`PATCH /repos/:owner/:repo/import/lfs`](/rest/reference/migrations#update-git-lfs-preference) (write) {% endif %} ### Reactions - -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) ### Releases -- [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (:read) -- [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (:write) -- [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (:read) -- [`PATCH /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#update-a-release) (:write) -- [`DELETE /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#delete-a-release) (:write) -- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/rest/reference/repos/#list-release-assets) (:read) -- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#get-a-release-asset) (:read) -- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#update-a-release-asset) (:write) -- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#delete-a-release-asset) (:write) -- [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (:read) -- [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (:read) +- [`GET /repos/:owner/:repo/releases`](/rest/reference/repos/#list-releases) (read) +- [`POST /repos/:owner/:repo/releases`](/rest/reference/repos/#create-a-release) (write) +- [`GET /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#get-a-release) (read) +- [`PATCH /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#update-a-release) (write) +- [`DELETE /repos/:owner/:repo/releases/:release_id`](/rest/reference/repos/#delete-a-release) (write) +- [`GET /repos/:owner/:repo/releases/:release_id/assets`](/rest/reference/repos/#list-release-assets) (read) +- [`GET /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#get-a-release-asset) (read) +- [`PATCH /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#update-a-release-asset) (write) +- [`DELETE /repos/:owner/:repo/releases/assets/:asset_id`](/rest/reference/repos/#delete-a-release-asset) (write) +- [`GET /repos/:owner/:repo/releases/latest`](/rest/reference/repos/#get-the-latest-release) (read) +- [`GET /repos/:owner/:repo/releases/tags/:tag`](/rest/reference/repos/#get-a-release-by-tag-name) (read) -## Permission on "deployments" +{% ifversion dependabot-alerts-rest-api %} +## Dependabot alerts -- [`GET /repos/:owner/:repo/deployments`](/rest/reference/deployments#list-deployments) (:read) -- [`POST /repos/:owner/:repo/deployments`](/rest/reference/deployments#create-a-deployment) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#get-a-deployment) (:read) -- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#delete-a-deployment) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#list-deployment-statuses) (:read) -- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#create-a-deployment-status) (:write) -- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/deployments#get-a-deployment-status) (:read) +- [`GET /repos/:owner/:repo/dependabot/alerts`](/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/dependabot/alerts/:alert_number`](/rest/dependabot/alerts#get-a-dependabot-alert) (read) +- [`PATCH /repos/:owner/:repo/dependabot/alerts/:alert_number`](/rest/dependabot/alerts#update-a-dependabot-alert) (write) +{% endif %} + +{% ifversion fpt or ghec or ghes > 3.3%} + +## Dependabot secrets + +- [`GET /repos/:owner/:repo/dependabot/secrets/public-key`](/rest/reference/dependabot#get-a-repository-public-key) (read) +- [`GET /repos/:owner/:repo/dependabot/secrets`](/rest/reference/dependabot#list-repository-secrets) (read) +- [`GET /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-a-repository-secret) (read) +- [`PUT /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-a-repository-secret) (write) +- [`DELETE /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-a-repository-secret) (write) +- [`GET /orgs/:org/dependabot/secrets/public-key`](/rest/reference/dependabot#get-an-organization-public-key) (read) +- [`GET /orgs/:org/dependabot/secrets`](/rest/reference/dependabot#list-organization-secrets) (read) +- [`GET /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-an-organization-secret) (read) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-an-organization-secret) (write) +- [`GET /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret) (read) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) (write) +- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#add-selected-repository-to-an-organization-secret) (write) +- [`DELETE /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) (write) +- [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (write) +{% endif %} + + +## Deployments + +- [`GET /repos/:owner/:repo/deployments`](/rest/reference/deployments#list-deployments) (read) +- [`POST /repos/:owner/:repo/deployments`](/rest/reference/deployments#create-a-deployment) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#get-a-deployment) (read) +- [`DELETE /repos/:owner/:repo/deployments/:deployment_id`](/rest/reference/deployments#delete-a-deployment) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#list-deployment-statuses) (read) +- [`POST /repos/:owner/:repo/deployments/:deployment_id/statuses`](/rest/reference/deployments#create-a-deployment-status) (write) +- [`GET /repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id`](/rest/reference/deployments#get-a-deployment-status) (read) {% ifversion fpt or ghes or ghec %} -## Permission on "emails" + +## Email addresses {% ifversion fpt or ghec -%} -- [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (:write) +- [`PATCH /user/email/visibility`](/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) (write) {% endif -%} -- [`GET /user/emails`](/rest/reference/users#list-email-addresses-for-the-authenticated-user) (:read) -- [`POST /user/emails`](/rest/reference/users#add-an-email-address-for-the-authenticated-user) (:write) -- [`DELETE /user/emails`](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) (:write) -- [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (:read) +- [`GET /user/emails`](/rest/reference/users#list-email-addresses-for-the-authenticated-user) (read) +- [`POST /user/emails`](/rest/reference/users#add-an-email-address-for-the-authenticated-user) (write) +- [`DELETE /user/emails`](/rest/reference/users#delete-an-email-address-for-the-authenticated-user) (write) +- [`GET /user/public_emails`](/rest/reference/users#list-public-email-addresses-for-the-authenticated-user) (read) {% endif %} -## Permission on "followers" + +## Followers -- [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (:read) -- [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (:read) -- [`GET /user/following/:username`](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) (:read) -- [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (:write) -- [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (:write) +- [`GET /user/followers`](/rest/reference/users#list-followers-of-a-user) (read) +- [`GET /user/following`](/rest/reference/users#list-the-people-a-user-follows) (read) +- [`GET /user/following/:username`](/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user) (read) +- [`PUT /user/following/:username`](/rest/reference/users#follow-a-user) (write) +- [`DELETE /user/following/:username`](/rest/reference/users#unfollow-a-user) (write) -## Permission on "gpg keys" + +## Git SSH keys -- [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (:read) -- [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (:write) -- [`GET /user/gpg_keys/:gpg_key_id`](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) (:read) -- [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (:write) +- [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (read) +- [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (write) +- [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (read) +- [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (write) + + +## GPG keys + +- [`GET /user/gpg_keys`](/rest/reference/users#list-gpg-keys-for-the-authenticated-user) (read) +- [`POST /user/gpg_keys`](/rest/reference/users#create-a-gpg-key-for-the-authenticated-user) (write) +- [`GET /user/gpg_keys/:gpg_key_id`](/rest/reference/users#get-a-gpg-key-for-the-authenticated-user) (read) +- [`DELETE /user/gpg_keys/:gpg_key_id`](/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user) (write) {% ifversion fpt or ghec %} -## Permission on "interaction limits" + +## Interaction limits -- [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (:read) -- [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (:write) -- [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (:write) +- [`GET /user/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-your-public-repositories) (read) +- [`PUT /user/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-your-public-repositories) (write) +- [`DELETE /user/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-from-your-public-repositories) (write) {% endif %} -## Permission on "issues" + +## Issues Issues and pull requests are closely related. For more information, see "[List issues assigned to the authenticated user](/rest/reference/issues#list-issues-assigned-to-the-authenticated-user)." If your GitHub App has permissions on issues but not on pull requests, these endpoints will be limited to issues. Endpoints that return both issues and pull requests will be filtered. Endpoints that allow operations on both issues and pull requests will be restricted to issues. -- [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (:read) -- [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#get-an-issue) (:read) -- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (:read) -- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (:read) -- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) +- [`GET /repos/:owner/:repo/issues`](/rest/reference/issues#list-repository-issues) (read) +- [`POST /repos/:owner/:repo/issues`](/rest/reference/issues#create-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#get-an-issue) (read) +- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (read) +- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (read) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (read) +- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) ### Assignees -- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) -- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) +- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (read) +- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (write) ### Events -- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) -- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) +- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (read) +- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (read) ### Labels -- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (:write) -- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (:write) -- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (:read) -- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) -- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (write) +- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (read) +- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (write) +- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (read) +- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (write) +- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (write) ### Milestones -- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) -- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) -- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (:write) -- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) +- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (read) +- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (read) +- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (write) +- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (read) ### Reactions -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#list-reactions-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) -## Permission on "keys" - -### Keys -- [`GET /user/keys`](/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user) (:read) -- [`POST /user/keys`](/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user) (:write) -- [`GET /user/keys/:key_id`](/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user) (:read) -- [`DELETE /user/keys/:key_id`](/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user) (:write) - -## Permission on "members" + +## Members {% ifversion fpt or ghec -%} -- [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (:write) +- [`GET /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#list-idp-groups-for-a-team) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PATCH /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#create-or-update-idp-group-connections) (:write) +- [`PATCH /organizations/:org_id/team/:team_id/team-sync/group-mappings`](/rest/reference/teams#create-or-update-idp-group-connections) (write) {% endif -%} -- [`GET /orgs/:org/outside_collaborators`](/rest/reference/orgs#list-outside-collaborators-for-an-organization) (:read) -- [`PUT /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) (:write) -- [`DELETE /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) (:write) +- [`GET /orgs/:org/outside_collaborators`](/rest/reference/orgs#list-outside-collaborators-for-an-organization) (read) +- [`PUT /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator) (write) +- [`DELETE /orgs/:org/outside_collaborators/:username`](/rest/reference/orgs#remove-outside-collaborator-from-an-organization) (write) {% ifversion fpt or ghec -%} -- [`GET /orgs/:org/team-sync/groups`](/rest/teams/team-sync#list-idp-groups-for-an-organization) (:write) +- [`GET /orgs/:org/team-sync/groups`](/rest/teams/team-sync#list-idp-groups-for-an-organization) (write) {% endif -%} -- [`GET /orgs/:org/team/:team_id`](/rest/teams/teams#get-a-team-by-name) (:read) +- [`GET /orgs/:org/team/:team_id`](/rest/teams/teams#get-a-team-by-name) (read) {% ifversion fpt or ghec -%} -- [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (:write) +- [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`POST /scim/v2/orgs/:org/Users`](/rest/reference/scim#provision-and-invite-a-scim-user) (:write) +- [`POST /scim/v2/orgs/:org/Users`](/rest/reference/scim#provision-and-invite-a-scim-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (:write) +- [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#set-scim-information-for-a-provisioned-user) (:write) +- [`PUT /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#set-scim-information-for-a-provisioned-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`PATCH /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#update-an-attribute-for-a-scim-user) (:write) +- [`PATCH /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#update-an-attribute-for-a-scim-user) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#delete-a-scim-user-from-an-organization) (:write) +- [`DELETE /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#delete-a-scim-user-from-an-organization) (write) {% endif %} {% ifversion fpt or ghec %} ### Invitations -- [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (:read) -- [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (:write) -- [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (:read) -- [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (:read) +- [`GET /orgs/:org/invitations`](/rest/reference/orgs#list-pending-organization-invitations) (read) +- [`POST /orgs/:org/invitations`](/rest/reference/orgs#create-an-organization-invitation) (write) +- [`GET /orgs/:org/invitations/:invitation_id/teams`](/rest/reference/orgs#list-organization-invitation-teams) (read) +- [`GET /teams/:team_id/invitations`](/rest/reference/teams#list-pending-team-invitations) (read) {% endif %} ### Organization members -- [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (:write) -- [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (:read) -- [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (:write) -- [`DELETE /orgs/:org/memberships/:username`](/rest/reference/orgs#remove-organization-membership-for-a-user) (:write) -- [`PUT /orgs/:org/public_members/:username`](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) (:write) -- [`DELETE /orgs/:org/public_members/:username`](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) (:write) -- [`GET /user/memberships/orgs`](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) (:read) -- [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (:read) -- [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (:write) +- [`DELETE /orgs/:org/members/:username`](/rest/reference/orgs#remove-an-organization-member) (write) +- [`GET /orgs/:org/memberships/:username`](/rest/reference/orgs#get-organization-membership-for-a-user) (read) +- [`PUT /orgs/:org/memberships/:username`](/rest/reference/orgs#set-organization-membership-for-a-user) (write) +- [`DELETE /orgs/:org/memberships/:username`](/rest/reference/orgs#remove-organization-membership-for-a-user) (write) +- [`PUT /orgs/:org/public_members/:username`](/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user) (write) +- [`DELETE /orgs/:org/public_members/:username`](/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user) (write) +- [`GET /user/memberships/orgs`](/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user) (read) +- [`GET /user/memberships/orgs/:org`](/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user) (read) +- [`PATCH /user/memberships/orgs/:org`](/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user) (write) ### Team members -- [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (:read) -- [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (:read) -- [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (:write) -- [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (:write) +- [`GET /teams/:team_id/members`](/rest/reference/teams#list-team-members) (read) +- [`GET /teams/:team_id/memberships/:username`](/rest/reference/teams#get-team-membership-for-a-user) (read) +- [`PUT /teams/:team_id/memberships/:username`](/rest/reference/teams#add-or-update-team-membership-for-a-user) (write) +- [`DELETE /teams/:team_id/memberships/:username`](/rest/reference/teams#remove-team-membership-for-a-user) (write) ### Teams -- [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (:read) -- [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (:write) -- [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (:read) -- [`PATCH /teams/:team_id`](/rest/reference/teams#update-a-team) (:write) -- [`DELETE /teams/:team_id`](/rest/reference/teams#delete-a-team) (:write) -- [`GET /teams/:team_id/projects`](/rest/reference/teams#list-team-projects) (:read) -- [`GET /teams/:team_id/projects/:project_id`](/rest/reference/teams#check-team-permissions-for-a-project) (:read) -- [`PUT /teams/:team_id/projects/:project_id`](/rest/reference/teams#add-or-update-team-project-permissions) (:read) -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) -- [`GET /teams/:team_id/repos`](/rest/reference/teams#list-team-repositories) (:read) -- [`GET /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#check-team-permissions-for-a-repository) (:read) -- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (:read) -- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (:write) -- [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (:read) +- [`GET /orgs/:org/teams`](/rest/reference/teams#list-teams) (read) +- [`POST /orgs/:org/teams`](/rest/reference/teams#create-a-team) (write) +- [`GET /orgs/:org/teams/:team_slug`](/rest/reference/teams#get-a-team-by-name) (read) +- [`PATCH /teams/:team_id`](/rest/reference/teams#update-a-team) (write) +- [`DELETE /teams/:team_id`](/rest/reference/teams#delete-a-team) (write) +- [`GET /teams/:team_id/projects`](/rest/reference/teams#list-team-projects) (read) +- [`GET /teams/:team_id/projects/:project_id`](/rest/reference/teams#check-team-permissions-for-a-project) (read) +- [`PUT /teams/:team_id/projects/:project_id`](/rest/reference/teams#add-or-update-team-project-permissions) (read) +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) +- [`GET /teams/:team_id/repos`](/rest/reference/teams#list-team-repositories) (read) +- [`GET /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#check-team-permissions-for-a-repository) (read) +- [`PUT /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#add-or-update-team-repository-permissions) (read) +- [`DELETE /teams/:team_id/repos/:owner/:repo`](/rest/reference/teams#remove-a-repository-from-a-team) (write) +- [`GET /teams/:team_id/teams`](/rest/reference/teams#list-child-teams) (read) -## Permission on "organization administration" + +## Organization administration -- [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (:write) +- [`PATCH /orgs/:org`](/rest/reference/orgs#update-an-organization) (write) {% ifversion actions-cache-management -%} -- [`GET /orgs/:org/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-an-organization) (:read) -- [`GET /orgs/:org/actions/cache/usage-by-repository`](/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization) (:read) +- [`GET /orgs/:org/actions/cache/usage`](/rest/reference/actions#get-github-actions-cache-usage-for-an-organization) (read) +- [`GET /orgs/:org/actions/cache/usage-by-repository`](/rest/reference/actions#list-repositories-with-github-actions-cache-usage-for-an-organization) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`GET /orgs/:org/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) (:read) +- [`GET /orgs/:org/interaction-limits`](/rest/reference/interactions#get-interaction-restrictions-for-an-organization) (read) {% endif -%} {% ifversion fpt or ghec -%} -- [`PUT /orgs/:org/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) (:write) +- [`PUT /orgs/:org/interaction-limits`](/rest/reference/interactions#set-interaction-restrictions-for-an-organization) (write) {% endif -%} {% ifversion fpt or ghec -%} -- [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (:write) +- [`DELETE /orgs/:org/interaction-limits`](/rest/reference/interactions#remove-interaction-restrictions-for-an-organization) (write) {% endif %} -## Permission on "organization events" + +## Organization events -- [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (:read) - -## Permission on "organization hooks" - -- [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (:read) -- [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (:write) -- [`GET /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#get-an-organization-webhook) (:read) -- [`PATCH /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#update-an-organization-webhook) (:write) -- [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (:write) -- [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (:write) - -### Teams -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) +- [`GET /users/:username/events/orgs/:org`](/rest/reference/activity#list-organization-events-for-the-authenticated-user) (read) {% ifversion ghes %} -## Permission on "organization pre receive hooks" + +## Organization pre-receive hooks -- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (:read) -- [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (:read) -- [`PATCH /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) (:write) -- [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (:write) +- [`GET /orgs/:org/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization) (read) +- [`GET /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization) (read) +- [`PATCH /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization) (write) +- [`DELETE /orgs/:org/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization) (write) {% endif %} -## Permission on "organization projects" + +## Organization projects -- [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (:write) -- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) -- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) -- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (:write) -- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (:read) -- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (:write) -- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (:read) -- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (:write) -- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (:write) -- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (:read) -- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (:write) -- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (:read) -- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (:write) -- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (:write) -- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) +- [`POST /orgs/:org/projects`](/rest/reference/projects#create-an-organization-project) (write) +- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (read) +- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (write) +- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (write) +- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (read) +- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (write) +- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (read) +- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (write) +- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (write) +- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (read) +- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (write) +- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (read) +- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (write) +- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (write) +- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (write) {% ifversion fpt or ghec %} -## Permission on "organization user blocking" + +## Organization user blocking -- [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (:read) -- [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (:read) -- [`PUT /orgs/:org/blocks/:username`](/rest/reference/orgs#block-a-user-from-an-organization) (:write) -- [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (:write) +- [`GET /orgs/:org/blocks`](/rest/reference/orgs#list-users-blocked-by-an-organization) (read) +- [`GET /orgs/:org/blocks/:username`](/rest/reference/orgs#check-if-a-user-is-blocked-by-an-organization) (read) +- [`PUT /orgs/:org/blocks/:username`](/rest/reference/orgs#block-a-user-from-an-organization) (write) +- [`DELETE /orgs/:org/blocks/:username`](/rest/reference/orgs#unblock-a-user-from-an-organization) (write) {% endif %} -## Permission on "pages" + +## Organization webhooks + +- [`GET /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#list-organization-webhooks) (read) +- [`POST /orgs/:org/hooks`](/rest/reference/orgs#webhooks/#create-an-organization-webhook) (write) +- [`GET /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#get-an-organization-webhook) (read) +- [`PATCH /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#update-an-organization-webhook) (write) +- [`DELETE /orgs/:org/hooks/:hook_id`](/rest/reference/orgs#webhooks/#delete-an-organization-webhook) (write) +- [`POST /orgs/:org/hooks/:hook_id/pings`](/rest/reference/orgs#webhooks/#ping-an-organization-webhook) (write) + +### Teams +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) + + +## Pages GitHub Pages can only be created or unpublished by a repository owner or administrator. -- [`GET /repos/:owner/:repo/pages`](/rest/reference/pages#get-a-github-pages-site) (:read) -- [`PUT /repos/:owner/:repo/pages`](/rest/reference/pages#update-information-about-a-github-pages-site) (:write) -- [`GET /repos/:owner/:repo/pages/builds`](/rest/reference/pages#list-github-pages-builds) (:read) -- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/pages#request-a-github-pages-build) (:write) -- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/pages#get-github-pages-build) (:read) -- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/pages#get-latest-pages-build) (:read) +- [`GET /repos/:owner/:repo/pages`](/rest/reference/pages#get-a-github-pages-site) (read) +- [`PUT /repos/:owner/:repo/pages`](/rest/reference/pages#update-information-about-a-github-pages-site) (write) +- [`GET /repos/:owner/:repo/pages/builds`](/rest/reference/pages#list-github-pages-builds) (read) +- [`POST /repos/:owner/:repo/pages/builds`](/rest/reference/pages#request-a-github-pages-build) (write) +- [`GET /repos/:owner/:repo/pages/builds/:build_id`](/rest/reference/pages#get-github-pages-build) (read) +- [`GET /repos/:owner/:repo/pages/builds/latest`](/rest/reference/pages#get-latest-pages-build) (read) {% ifversion fpt or ghec -%} -- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (:write) -- [`POST /repos/:owner/:repo/pages/deployment`](/rest/reference/repos#create-a-github-pages-deployment) (:write) +- [`GET /repos/:owner/:repo/pages/health`](/rest/reference/pages#get-a-dns-health-check-for-github-pages) (write) +- [`POST /repos/:owner/:repo/pages/deployment`](/rest/reference/repos#create-a-github-pages-deployment) (write) {% endif %} -## Permission on "pull requests" + +## Profile + +- [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (write) + + +## Pull requests Pull requests and issues are closely related. If your GitHub App has permissions on pull requests but not on issues, these endpoints will be limited to pull requests. Endpoints that return both pull requests and issues will be filtered. Endpoints that allow operations on both pull requests and issues will be restricted to pull requests. -- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (:read) -- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (:read) -- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/pulls`](/rest/reference/pulls#list-pull-requests) (:read) -- [`POST /repos/:owner/:repo/pulls`](/rest/reference/pulls#create-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#get-a-pull-request) (:read) -- [`PATCH /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#update-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#list-review-comments-on-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/commits`](/rest/reference/pulls#list-commits-on-a-pull-request) (:read) -- [`GET /repos/:owner/:repo/pulls/:pull_number/files`](/rest/reference/pulls#list-pull-requests-files) (:read) -- [`GET /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) (:read) -- [`GET /repos/:owner/:repo/pulls/comments`](/rest/reference/pulls#list-review-comments-in-a-repository) (:read) -- [`GET /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) (:read) -- [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (:write) +- [`PATCH /repos/:owner/:repo/issues/:issue_number`](/rest/reference/issues#update-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#list-issue-comments) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/comments`](/rest/reference/issues#create-an-issue-comment) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#lock-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/lock`](/rest/reference/issues#unlock-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/:issue_number/timeline`](/rest/reference/issues#list-timeline-events-for-an-issue) (read) +- [`GET /repos/:owner/:repo/issues/comments`](/rest/reference/issues#list-issue-comments-for-a-repository) (read) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#get-an-issue-comment) (read) +- [`PATCH /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#update-an-issue-comment) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id`](/rest/reference/issues#delete-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/pulls`](/rest/reference/pulls#list-pull-requests) (read) +- [`POST /repos/:owner/:repo/pulls`](/rest/reference/pulls#create-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#get-a-pull-request) (read) +- [`PATCH /repos/:owner/:repo/pulls/:pull_number`](/rest/reference/pulls#update-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#list-review-comments-on-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/comments`](/rest/reference/pulls#create-a-review-comment-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/commits`](/rest/reference/pulls#list-commits-on-a-pull-request) (read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/files`](/rest/reference/pulls#list-pull-requests-files) (read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/merge`](/rest/reference/pulls#check-if-a-pull-request-has-been-merged) (read) +- [`GET /repos/:owner/:repo/pulls/comments`](/rest/reference/pulls#list-review-comments-in-a-repository) (read) +- [`GET /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#get-a-review-comment-for-a-pull-request) (read) +- [`PATCH /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#update-a-review-comment-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id`](/rest/reference/pulls#delete-a-review-comment-for-a-pull-request) (write) ### Assignees -- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (:read) -- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (:write) +- [`GET /repos/:owner/:repo/assignees`](/rest/reference/issues#list-assignees) (read) +- [`GET /repos/:owner/:repo/assignees/:username`](/rest/reference/issues#check-if-a-user-can-be-assigned) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#add-assignees-to-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/assignees`](/rest/reference/issues#remove-assignees-from-an-issue) (write) ### Events -- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (:read) -- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/events`](/rest/reference/issues#list-issue-events) (read) +- [`GET /repos/:owner/:repo/issues/events/:event_id`](/rest/reference/issues#get-an-issue-event) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events`](/rest/reference/pulls#submit-a-review-for-a-pull-request) (write) ### Labels -- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (:read) -- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (:write) -- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (:write) -- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (:read) -- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (:write) -- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (:read) -- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (:write) -- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (:write) +- [`GET /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#list-labels-for-an-issue) (read) +- [`POST /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#add-labels-to-an-issue) (write) +- [`PUT /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#set-labels-for-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels`](/rest/reference/issues#remove-all-labels-from-an-issue) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/labels/:name`](/rest/reference/issues#remove-a-label-from-an-issue) (write) +- [`GET /repos/:owner/:repo/labels`](/rest/reference/issues#list-labels-for-a-repository) (read) +- [`POST /repos/:owner/:repo/labels`](/rest/reference/issues#create-a-label) (write) +- [`GET /repos/:owner/:repo/labels/:name`](/rest/reference/issues#get-a-label) (read) +- [`PATCH /repos/:owner/:repo/labels/:name`](/rest/reference/issues#update-a-label) (write) +- [`DELETE /repos/:owner/:repo/labels/:name`](/rest/reference/issues#delete-a-label) (write) ### Milestones -- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (:read) -- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (:read) -- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (:write) -- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (:write) -- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (:read) +- [`GET /repos/:owner/:repo/milestones`](/rest/reference/issues#list-milestones) (read) +- [`POST /repos/:owner/:repo/milestones`](/rest/reference/issues#create-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#get-a-milestone) (read) +- [`PATCH /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#update-a-milestone) (write) +- [`DELETE /repos/:owner/:repo/milestones/:milestone_number`](/rest/reference/issues#delete-a-milestone) (write) +- [`GET /repos/:owner/:repo/milestones/:milestone_number/labels`](/rest/reference/issues#list-labels-for-issues-in-a-milestone) (read) ### Reactions -- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (:write) -- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (:read) -- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (:write) -- [`GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) (:read) -- [`POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) (:write) -- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (:write) -- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (:write) -- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (:write) -- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (:write) -- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (:write) +- [`POST /repos/:owner/:repo/issues/:issue_number/reactions`](/rest/reference/reactions#create-reaction-for-an-issue) (write) +- [`GET /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-an-issue-comment) (read) +- [`POST /repos/:owner/:repo/issues/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-an-issue-comment) (write) +- [`GET /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment) (read) +- [`POST /repos/:owner/:repo/pulls/comments/:comment_id/reactions`](/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment) (write) +- [`DELETE /reactions/:reaction_id`](/rest/reference/reactions#delete-a-reaction-legacy) (write) +- [`DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-commit-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-reaction) (write) +- [`DELETE /repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-an-issue-comment-reaction) (write) +- [`DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id`](/rest/reference/reactions#delete-a-pull-request-comment-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-reaction) (write) +- [`DELETE /orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`](/rest/reference/reactions#delete-team-discussion-comment-reaction) (write) ### Requested reviewers -- [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (:write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#list-requested-reviewers-for-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#request-reviewers-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/:pull_number/requested_reviewers`](/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request) (write) ### Reviews -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (:read) -- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (:read) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#update-a-review-for-a-pull-request) (:write) -- [`DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#delete-a-pending-review-for-a-pull-request) (:write) -- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (:read) -- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (:write) - -## Permission on "profile" - -- [`PATCH /user`](/rest/reference/users#update-the-authenticated-user) (:write) - -## Permission on "repository hooks" - -- [`GET /repos/:owner/:repo/hooks`](/rest/reference/webhooks#list-repository-webhooks) (:read) -- [`POST /repos/:owner/:repo/hooks`](/rest/reference/webhooks#create-a-repository-webhook) (:write) -- [`GET /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#get-a-repository-webhook) (:read) -- [`PATCH /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#update-a-repository-webhook) (:write) -- [`DELETE /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#delete-a-repository-webhook) (:write) -- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/rest/reference/webhooks#ping-a-repository-webhook) (:read) -- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (:read) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#list-reviews-for-a-pull-request) (read) +- [`POST /repos/:owner/:repo/pulls/:pull_number/reviews`](/rest/reference/pulls#create-a-review-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#get-a-review-for-a-pull-request) (read) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#update-a-review-for-a-pull-request) (write) +- [`DELETE /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id`](/rest/reference/pulls#delete-a-pending-review-for-a-pull-request) (write) +- [`GET /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments`](/rest/reference/pulls#list-comments-for-a-pull-request-review) (read) +- [`PUT /repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals`](/rest/reference/pulls#dismiss-a-review-for-a-pull-request) (write) {% ifversion ghes %} -## Permission on "repository pre receive hooks" + +## Repository pre-receive hooks -- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (:read) -- [`PATCH /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) (:write) -- [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (:write) +- [`GET /repos/:owner/:repo/pre-receive-hooks`](/enterprise/user/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository) (read) +- [`GET /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository) (read) +- [`PATCH /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository) (write) +- [`DELETE /repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id`](/enterprise/user/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository) (write) {% endif %} -## Permission on "repository projects" + +## Repository projects -- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (:read) -- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (:write) -- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (:write) -- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (:read) -- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (:write) -- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (:read) -- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (:write) -- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (:write) -- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (:read) -- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (:write) -- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (:write) -- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (:read) -- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (:write) -- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (:write) -- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (:write) -- [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (:read) -- [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (:write) +- [`GET /projects/:project_id`](/rest/reference/projects#get-a-project) (read) +- [`PATCH /projects/:project_id`](/rest/reference/projects#update-a-project) (write) +- [`DELETE /projects/:project_id`](/rest/reference/projects#delete-a-project) (write) +- [`POST /projects/:project_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`GET /projects/:project_id/columns`](/rest/reference/projects#list-project-columns) (read) +- [`POST /projects/:project_id/columns`](/rest/reference/projects#create-a-project-column) (write) +- [`GET /projects/columns/:column_id`](/rest/reference/projects#get-a-project-column) (read) +- [`PATCH /projects/columns/:column_id`](/rest/reference/projects#update-a-project-column) (write) +- [`DELETE /projects/columns/:column_id`](/rest/reference/projects#delete-a-project-column) (write) +- [`GET /projects/columns/:column_id/cards`](/rest/reference/projects#list-project-cards) (read) +- [`POST /projects/columns/:column_id/cards`](/rest/reference/projects#create-a-project-card) (write) +- [`POST /projects/columns/:column_id/moves`](/rest/reference/projects#move-a-project-column) (write) +- [`GET /projects/columns/cards/:card_id`](/rest/reference/projects#get-a-project-card) (read) +- [`PATCH /projects/columns/cards/:card_id`](/rest/reference/projects#update-a-project-card) (write) +- [`DELETE /projects/columns/cards/:card_id`](/rest/reference/projects#delete-a-project-card) (write) +- [`POST /projects/columns/cards/:card_id/moves`](/rest/reference/projects#move-a-project-card) (write) +- [`GET /repos/:owner/:repo/projects`](/rest/reference/projects#list-repository-projects) (read) +- [`POST /repos/:owner/:repo/projects`](/rest/reference/projects#create-a-repository-project) (write) ### Teams -- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (:read) +- [`DELETE /teams/:team_id/projects/:project_id`](/rest/reference/teams#remove-a-project-from-a-team) (read) + + +## Repository webhooks + +- [`GET /repos/:owner/:repo/hooks`](/rest/reference/webhooks#list-repository-webhooks) (read) +- [`POST /repos/:owner/:repo/hooks`](/rest/reference/webhooks#create-a-repository-webhook) (write) +- [`GET /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#get-a-repository-webhook) (read) +- [`PATCH /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#update-a-repository-webhook) (write) +- [`DELETE /repos/:owner/:repo/hooks/:hook_id`](/rest/reference/webhooks#delete-a-repository-webhook) (write) +- [`POST /repos/:owner/:repo/hooks/:hook_id/pings`](/rest/reference/webhooks#ping-a-repository-webhook) (read) +- [`POST /repos/:owner/:repo/hooks/:hook_id/tests`](/rest/reference/repos#test-the-push-repository-webhook) (read) {% ifversion fpt or ghec %} -## Permission on "secrets" + +## Secrets -- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (:read) -- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (:read) -- [`GET /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#get-a-repository-secret) (:read) -- [`PUT /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-a-repository-secret) (:write) -- [`DELETE /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#delete-a-repository-secret) (:write) -- [`GET /orgs/:org/actions/secrets/public-key`](/rest/reference/actions#get-an-organization-public-key) (:read) -- [`GET /orgs/:org/actions/secrets`](/rest/reference/actions#list-organization-secrets) (:read) -- [`GET /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#get-an-organization-secret) (:read) -- [`PUT /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-an-organization-secret) (:write) -- [`GET /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) (:read) -- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) (:write) -- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#add-selected-repository-to-an-organization-secret) (:write) -- [`DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) (:write) -- [`DELETE /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#delete-an-organization-secret) (:write) -{% endif %} - -{% ifversion fpt or ghec or ghes > 3.3%} -## Permission on "dependabot_secrets" -- [`GET /repos/:owner/:repo/dependabot/secrets/public-key`](/rest/reference/dependabot#get-a-repository-public-key) (:read) -- [`GET /repos/:owner/:repo/dependabot/secrets`](/rest/reference/dependabot#list-repository-secrets) (:read) -- [`GET /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-a-repository-secret) (:read) -- [`PUT /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-a-repository-secret) (:write) -- [`DELETE /repos/:owner/:repo/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-a-repository-secret) (:write) -- [`GET /orgs/:org/dependabot/secrets/public-key`](/rest/reference/dependabot#get-an-organization-public-key) (:read) -- [`GET /orgs/:org/dependabot/secrets`](/rest/reference/dependabot#list-organization-secrets) (:read) -- [`GET /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#get-an-organization-secret) (:read) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#create-or-update-an-organization-secret) (:write) -- [`GET /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret) (:read) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories`](/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret) (:write) -- [`PUT /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#add-selected-repository-to-an-organization-secret) (:write) -- [`DELETE /orgs/:org/dependabot/secrets/:secret_name/repositories/:repository_id`](/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) (:write) -- [`DELETE /orgs/:org/dependabot/secrets/:secret_name`](/rest/reference/dependabot#delete-an-organization-secret) (:write) +- [`GET /repos/:owner/:repo/actions/secrets/public-key`](/rest/reference/actions#get-a-repository-public-key) (read) +- [`GET /repos/:owner/:repo/actions/secrets`](/rest/reference/actions#list-repository-secrets) (read) +- [`GET /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#get-a-repository-secret) (read) +- [`PUT /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-a-repository-secret) (write) +- [`DELETE /repos/:owner/:repo/actions/secrets/:secret_name`](/rest/reference/actions#delete-a-repository-secret) (write) +- [`GET /orgs/:org/actions/secrets/public-key`](/rest/reference/actions#get-an-organization-public-key) (read) +- [`GET /orgs/:org/actions/secrets`](/rest/reference/actions#list-organization-secrets) (read) +- [`GET /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#get-an-organization-secret) (read) +- [`PUT /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#create-or-update-an-organization-secret) (write) +- [`GET /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#list-selected-repositories-for-an-organization-secret) (read) +- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories`](/rest/reference/actions#set-selected-repositories-for-an-organization-secret) (write) +- [`PUT /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#add-selected-repository-to-an-organization-secret) (write) +- [`DELETE /orgs/:org/actions/secrets/:secret_name/repositories/:repository_id`](/rest/reference/actions#remove-selected-repository-from-an-organization-secret) (write) +- [`DELETE /orgs/:org/actions/secrets/:secret_name`](/rest/reference/actions#delete-an-organization-secret) (write) {% endif %} {% ifversion ghes or ghec %} -## Permission on "secret scanning alerts" + +## Secret scanning alerts -- [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (:read) -- [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) -- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations`](/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert) (:read) +- [`GET /repos/:owner/:repo/secret-scanning/alerts`](/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository) (read) +- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#get-a-secret-scanning-alert) (read) +- [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (write) +- [`GET /repos/:owner/:repo/secret-scanning/alerts/:alert_number/locations`](/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert) (read) {% endif %} -## Permission on "security events" - -- [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) -- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) -- [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (:write) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (:read) -{% endif -%} -- [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (:read) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (:read) -{% endif -%} -{% ifversion fpt or ghec or ghes -%} -- [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (:write) -{% endif -%} -- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (:write) -{% ifversion fpt or ghec or ghes or ghae -%} -- [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (:read) -{% endif -%} -{% ifversion fpt or ghec or ghes > 3.4 or ghae > 3.4 -%} -- [`GET /orgs/:org/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-by-organization) (:read) -{% endif -%} - {% ifversion fpt or ghes or ghec %} -## Permission on "self-hosted runners" -- [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (:write) -- [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (:read) -- [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (:write) -- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (:read) -- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (:write) -- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (:write) -- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (:write) + +## Self-hosted runners + +- [`GET /orgs/:org/actions/runners/downloads`](/rest/reference/actions#list-runner-applications-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/registration-token`](/rest/reference/actions#create-a-registration-token-for-an-organization) (write) +- [`GET /orgs/:org/actions/runners`](/rest/reference/actions#list-self-hosted-runners-for-an-organization) (read) +- [`GET /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#get-a-self-hosted-runner-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/remove-token`](/rest/reference/actions#create-a-remove-token-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id`](/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization) (write) +- [`GET /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#list-labels-for-a-self-hosted-runner-for-an-organization) (read) +- [`POST /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization) (write) +- [`PUT /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#set-custom-labels-for-a-self-hosted-runner-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels`](/rest/reference/actions#remove-all-custom-labels-from-a-self-hosted-runner-for-an-organization) (write) +- [`DELETE /orgs/:org/actions/runners/:runner_id/labels/:name`](/rest/reference/actions#remove-a-custom-label-from-a-self-hosted-runner-for-an-organization) (write) {% endif %} -## Permission on "single file" + +## Single file -- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (:read) -- [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (:write) -- [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (:write) +- [`GET /repos/:owner/:repo/contents/:path`](/rest/reference/repos#get-repository-content) (read) +- [`PUT /repos/:owner/:repo/contents/:path`](/rest/reference/repos#create-or-update-file-contents) (write) +- [`DELETE /repos/:owner/:repo/contents/:path`](/rest/reference/repos#delete-a-file) (write) -## Permission on "starring" + +## Starring -- [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (:read) -- [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (:write) -- [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (:write) +- [`GET /user/starred/:owner/:repo`](/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user) (read) +- [`PUT /user/starred/:owner/:repo`](/rest/reference/activity#star-a-repository-for-the-authenticated-user) (write) +- [`DELETE /user/starred/:owner/:repo`](/rest/reference/activity#unstar-a-repository-for-the-authenticated-user) (write) -## Permission on "statuses" + +## Team discussions -- [`GET /repos/:owner/:repo/commits/:ref/status`](/rest/reference/commits#get-the-combined-status-for-a-specific-reference) (:read) -- [`GET /repos/:owner/:repo/commits/:ref/statuses`](/rest/reference/commits#list-commit-statuses-for-a-reference) (:read) -- [`POST /repos/:owner/:repo/statuses/:sha`](/rest/reference/commits#create-a-commit-status) (:write) - -## Permission on "team discussions" - -- [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (:read) -- [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#get-a-discussion) (:read) -- [`PATCH /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#update-a-discussion) (:write) -- [`DELETE /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#delete-a-discussion) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#list-discussion-comments) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#create-a-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#get-a-discussion-comment) (:read) -- [`PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#update-a-discussion-comment) (:write) -- [`DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#delete-a-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) (:write) -- [`GET /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion) (:read) -- [`POST /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion) (:write) +- [`GET /teams/:team_id/discussions`](/rest/reference/teams#list-discussions) (read) +- [`POST /teams/:team_id/discussions`](/rest/reference/teams#create-a-discussion) (write) +- [`GET /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#get-a-discussion) (read) +- [`PATCH /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#update-a-discussion) (write) +- [`DELETE /teams/:team_id/discussions/:discussion_number`](/rest/reference/teams#delete-a-discussion) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#list-discussion-comments) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/comments`](/rest/reference/teams#create-a-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#get-a-discussion-comment) (read) +- [`PATCH /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#update-a-discussion-comment) (write) +- [`DELETE /teams/:team_id/discussions/:discussion_number/comments/:comment_number`](/rest/reference/teams#delete-a-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion-comment) (write) +- [`GET /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#list-reactions-for-a-team-discussion) (read) +- [`POST /teams/:team_id/discussions/:discussion_number/reactions`](/rest/reference/reactions#create-reaction-for-a-team-discussion) (write) diff --git a/translations/pt-BR/data/reusables/apps/metadata-permissions.md b/translations/pt-BR/data/reusables/apps/metadata-permissions.md deleted file mode 100644 index fb2cc9a654..0000000000 --- a/translations/pt-BR/data/reusables/apps/metadata-permissions.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -ms.openlocfilehash: 5cbe77b1e8580e79c7e77b99de3e1973191d2075 -ms.sourcegitcommit: 5b1461b419dbef60ae9dbdf8e905a4df30fc91b7 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/10/2022 -ms.locfileid: "147875597" ---- -Se você definir a permissão de metadados `No access` e selecionar uma permissão que exija acesso ao repositório, o GitHub substituirá sua seleção e definirá a permissão de metadados de novo para `Read-only`. Para definir a permissão de metadados como `No access`, primeiro, defina todas as permissões que exigem acesso ao repositório como `No access`.