Merge branch 'main' into codewithdev-ui-changes
This commit is contained in:
Steve Ward
Binary file not shown.
|
Before Width: | Height: | Size: 80 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 178 KiB |
BIN
assets/images/help/codespaces/vs-code-building-codespace.png
Normal file
BIN
assets/images/help/codespaces/vs-code-building-codespace.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 225 KiB |
BIN
assets/images/help/codespaces/web-ui-view-logs.png
Normal file
BIN
assets/images/help/codespaces/web-ui-view-logs.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
BIN
assets/images/oauth-apps/oauth_apps_sidebar_advanced.png
Normal file
BIN
assets/images/oauth-apps/oauth_apps_sidebar_advanced.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 58 KiB |
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Creating a composite action
|
||||
shortTitle: Create a composite action
|
||||
intro: 'In this guide, you''ll learn how to build a composite action.'
|
||||
redirect_from:
|
||||
- /actions/creating-actions/creating-a-composite-run-steps-action
|
||||
@@ -11,7 +12,6 @@ versions:
|
||||
type: tutorial
|
||||
topics:
|
||||
- Action development
|
||||
shortTitle: Composite action
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Creating a Docker container action
|
||||
shortTitle: Create a Docker container action
|
||||
intro: 'This guide shows you the minimal steps required to build a Docker container action. '
|
||||
redirect_from:
|
||||
- /articles/creating-a-docker-container-action
|
||||
@@ -15,7 +16,6 @@ type: tutorial
|
||||
topics:
|
||||
- Action development
|
||||
- Docker
|
||||
shortTitle: Docker container action
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Setting exit codes for actions
|
||||
shortTitle: Setting exit codes
|
||||
shortTitle: Set exit codes
|
||||
intro: 'You can use exit codes to set the status of an action. {% data variables.product.prodname_dotcom %} displays statuses to indicate passing or failing actions.'
|
||||
redirect_from:
|
||||
- /actions/building-actions/setting-exit-codes-for-actions
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Deploying to your cloud provider
|
||||
shortTitle: Deploying to your cloud provider
|
||||
shortTitle: Deploy to your cloud provider
|
||||
intro: 'You can deploy to various cloud providers, such as AWS, Azure, and GKE.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Deploying Xcode applications
|
||||
shortTitle: Deploying Xcode applications
|
||||
shortTitle: Deploy Xcode applications
|
||||
intro: 'You can sign Xcode apps within your continuous integration (CI) workflow by installing an Apple code signing certificate on {% data variables.product.prodname_actions %} runners.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Installing an Apple certificate on macOS runners for Xcode development
|
||||
shortTitle: Sign Xcode applications
|
||||
intro: 'You can sign Xcode apps within your continuous integration (CI) workflow by installing an Apple code signing certificate on {% data variables.product.prodname_actions %} runners.'
|
||||
redirect_from:
|
||||
- /actions/guides/installing-an-apple-certificate-on-macos-runners-for-xcode-development
|
||||
@@ -13,7 +14,6 @@ type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
- Xcode
|
||||
shortTitle: Sign Xcode applications
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing your deployments
|
||||
shortTitle: Managing your deployments
|
||||
shortTitle: Manage your deployments
|
||||
intro: You can review the past activity of your deployments.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Viewing deployment history
|
||||
shortTitle: View deployment history
|
||||
intro: View current and previous deployments for your repository.
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -8,7 +9,6 @@ versions:
|
||||
ghec: '*'
|
||||
topics:
|
||||
- API
|
||||
shortTitle: View deployment history
|
||||
redirect_from:
|
||||
- /developers/overview/viewing-deployment-history
|
||||
- /actions/deployment/viewing-deployment-history
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring OpenID Connect in Amazon Web Services
|
||||
shortTitle: Configuring OpenID Connect in Amazon Web Services
|
||||
shortTitle: OpenID Connect in AWS
|
||||
intro: Use OpenID Connect within your workflows to authenticate with Amazon Web Services.
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring OpenID Connect in Azure
|
||||
shortTitle: Configuring OpenID Connect in Azure
|
||||
shortTitle: OpenID Connect in Azure
|
||||
intro: Use OpenID Connect within your workflows to authenticate with Azure.
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring OpenID Connect in cloud providers
|
||||
shortTitle: Configuring OpenID Connect in cloud providers
|
||||
shortTitle: OpenID Connect in cloud providers
|
||||
intro: Use OpenID Connect within your workflows to authenticate with cloud providers.
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring OpenID Connect in Google Cloud Platform
|
||||
shortTitle: Configuring OpenID Connect in Google Cloud Platform
|
||||
shortTitle: OpenID Connect in Google Cloud Platform
|
||||
intro: Use OpenID Connect within your workflows to authenticate with Google Cloud Platform.
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Security hardening your deployments
|
||||
shortTitle: Security hardening your deployments
|
||||
shortTitle: Security harden deployments
|
||||
intro: Use OpenID Connect within your workflows to authenticate with your cloud provider.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using OpenID Connect with reusable workflows
|
||||
shortTitle: Using OpenID Connect with reusable workflows
|
||||
shortTitle: OpenID Connect with reusable workflows
|
||||
intro: You can use reusable workflows with OIDC to standardize and security harden your deployment steps.
|
||||
miniTocMaxHeadingLevel: 3
|
||||
redirect_from:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Targeting different environments
|
||||
shortTitle: Targeting different environments
|
||||
shortTitle: Target different environments
|
||||
intro: You can configure environments with protection rules and secrets. A workflow job that references an environment must follow any protection rules for the environment before running or accessing the environment's secrets.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: 'Using concurrency, expressions, and a test matrix'
|
||||
shortTitle: 'Using concurrency, expressions, and a test matrix'
|
||||
shortTitle: 'Use concurrency, expressions, and a test matrix'
|
||||
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using scripts to test your code on a runner
|
||||
shortTitle: Using scripts to test your code on a runner
|
||||
shortTitle: Use scripts to test your code on a runner
|
||||
intro: 'How to use essential {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using the GitHub CLI on a runner
|
||||
shortTitle: Using the GitHub CLI on a runner
|
||||
shortTitle: Use the GitHub CLI on a runner
|
||||
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -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: '*'
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Hosting your own runners
|
||||
shortTitle: Self-hosted runners
|
||||
intro: You can create self-hosted runners to run workflows in a highly customizable environment.
|
||||
redirect_from:
|
||||
- /github/automating-your-workflow-with-github-actions/hosting-your-own-runners
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Adding labels to issues
|
||||
shortTitle: Add labels to issues
|
||||
intro: 'You can use {% data variables.product.prodname_actions %} to automatically label issues.'
|
||||
redirect_from:
|
||||
- /actions/guides/adding-labels-to-issues
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Closing inactive issues
|
||||
shortTitle: Close inactive issues
|
||||
intro: 'You can use {% data variables.product.prodname_actions %} to comment on or close issues that have been inactive for a certain period of time.'
|
||||
redirect_from:
|
||||
- /actions/guides/closing-inactive-issues
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing issues and pull requests
|
||||
shortTitle: Managing issues and pull requests
|
||||
shortTitle: Manage issues and pull requests
|
||||
intro: 'You can automatically manage your issues and pull requests using {% data variables.product.prodname_actions %} workflows.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Scheduling issue creation
|
||||
shortTitle: Schedule issue creation
|
||||
intro: 'You can use {% data variables.product.prodname_actions %} to create an issue on a regular basis for things like daily meetings or quarterly reviews.'
|
||||
redirect_from:
|
||||
- /actions/guides/scheduling-issue-creation
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Canceling a workflow
|
||||
shortTitle: Cancel a workflow
|
||||
intro: 'You can cancel a workflow run that is in progress. When you cancel a workflow run, {% data variables.product.prodname_dotcom %} cancels all jobs and steps that are a part of that workflow.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Deleting a workflow run
|
||||
shortTitle: Delete a workflow run
|
||||
intro: 'You can delete a workflow run that has been completed, or is more than two weeks old.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing workflow runs
|
||||
shortTitle: Managing workflow runs
|
||||
shortTitle: Manage workflow runs
|
||||
intro: 'You can re-run or cancel a workflow, {% ifversion fpt or ghes or ghae %}review deployments, {% endif %}view billable job execution minutes, and download artifacts.'
|
||||
redirect_from:
|
||||
- /actions/configuring-and-managing-workflows/managing-a-workflow-run
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Reviewing deployments
|
||||
shortTitle: Review deployments
|
||||
intro: You can approve or reject jobs awaiting review.
|
||||
product: '{% data reusables.gated-features.environments %}'
|
||||
versions:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Migrating to GitHub Actions
|
||||
shortTitle: Migrating to GitHub Actions
|
||||
shortTitle: Migrate to GitHub Actions
|
||||
intro: 'Learn how to migrate your existing CI/CD workflows to {% data variables.product.prodname_actions %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Adding a workflow status badge
|
||||
shortTitle: Add a status badge
|
||||
intro: You can display a status badge in your repository to indicate the status of your workflows.
|
||||
redirect_from:
|
||||
- /actions/managing-workflow-runs/adding-a-workflow-status-badge
|
||||
@@ -8,7 +9,6 @@ versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Add a status badge
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Enabling debug logging
|
||||
shortTitle: Enable debug logging
|
||||
intro: 'If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging.'
|
||||
redirect_from:
|
||||
- /actions/managing-workflow-runs/enabling-debug-logging
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
---
|
||||
title: Notifications for workflow runs
|
||||
shortTitle: Notifications for workflow runs
|
||||
intro: You can subscribe to notifications about workflow runs that you trigger.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Notifications
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Using the visualization graph
|
||||
shortTitle: Visualization graph
|
||||
intro: Every workflow run generates a real-time graph that illustrates the run progress. You can use this graph to monitor and debug workflows.
|
||||
redirect_from:
|
||||
- /actions/managing-workflow-runs/using-the-visualization-graph
|
||||
@@ -8,7 +9,6 @@ versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Use the visualization graph
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Using workflow run logs
|
||||
shortTitle: Workflow run logs
|
||||
intro: 'You can view, search, and download the logs for each job in a workflow run.'
|
||||
redirect_from:
|
||||
- /actions/managing-workflow-runs/using-workflow-run-logs
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
---
|
||||
title: Viewing job execution time
|
||||
shortTitle: View job execution time
|
||||
intro: 'You can view the execution time of a job, including the billable minutes that a job accrued.'
|
||||
redirect_from:
|
||||
- /actions/managing-workflow-runs/viewing-job-execution-time
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
shortTitle: View job execution time
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Viewing workflow run history
|
||||
shortTitle: Workflow run history
|
||||
intro: You can view logs for each run of a workflow. Logs include the status for each job and step in a workflow.
|
||||
redirect_from:
|
||||
- /actions/managing-workflow-runs/viewing-workflow-run-history
|
||||
@@ -8,7 +9,6 @@ versions:
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: View workflow run history
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Publishing packages
|
||||
shortTitle: Publishing packages
|
||||
shortTitle: Publish packages
|
||||
intro: 'You can automatically publish packages using {% data variables.product.prodname_actions %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Publishing Java packages with Gradle
|
||||
shortTitle: Publish Java packages with Gradle
|
||||
intro: You can use Gradle to publish Java packages to a registry as part of your continuous integration (CI) workflow.
|
||||
redirect_from:
|
||||
- /actions/language-and-framework-guides/publishing-java-packages-with-gradle
|
||||
@@ -15,7 +16,6 @@ topics:
|
||||
- Publishing
|
||||
- Java
|
||||
- Gradle
|
||||
shortTitle: Java packages with Gradle
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Publishing Java packages with Maven
|
||||
shortTitle: Publish Java packages with Maven
|
||||
intro: You can use Maven to publish Java packages to a registry as part of your continuous integration (CI) workflow.
|
||||
redirect_from:
|
||||
- /actions/language-and-framework-guides/publishing-java-packages-with-maven
|
||||
@@ -15,7 +16,6 @@ topics:
|
||||
- Publishing
|
||||
- Java
|
||||
- Maven
|
||||
shortTitle: Java packages with Maven
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Creating PostgreSQL service containers
|
||||
shortTitle: PostgreSQL service containers
|
||||
shortTitle: Create PostgreSQL service containers
|
||||
intro: You can create a PostgreSQL service container to use in your workflow. This guide shows examples of creating a PostgreSQL service for jobs that run in containers or directly on the runner machine.
|
||||
redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/creating-postgresql-service-containers
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Creating Redis service containers
|
||||
shortTitle: Redis service containers
|
||||
shortTitle: Create Redis service containers
|
||||
intro: You can use service containers to create a Redis client in your workflow. This guide shows examples of creating a Redis service for jobs that run in containers or directly on the runner machine.
|
||||
redirect_from:
|
||||
- /actions/automating-your-workflow-with-github-actions/creating-redis-service-containers
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Connecting to a private network
|
||||
shortTitle: Connect to a private network
|
||||
intro: 'You can connect {% data variables.product.prodname_dotcom %}-hosted runners to resources on a private network, including package registries, secret managers, and other on-premises services.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: Controlling access to larger runners
|
||||
shortTitle: Control access to {% data variables.actions.hosted_runner %}s
|
||||
intro: You can use policies to limit access to {% data variables.actions.hosted_runner %}s that have been added to an organization or enterprise.
|
||||
product: '{% data reusables.gated-features.hosted-runners %}'
|
||||
versions:
|
||||
feature: 'actions-hosted-runners'
|
||||
type: tutorial
|
||||
shortTitle: Controlling access to {% data variables.actions.hosted_runner %}s
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Using GitHub-hosted runners
|
||||
shortTitle: GitHub-hosted runners
|
||||
intro: You can use GitHub's runners to execute your GitHub Actions workflows.
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -12,7 +13,6 @@ children:
|
||||
- /monitoring-your-current-jobs
|
||||
- /customizing-github-hosted-runners
|
||||
- /connecting-to-a-private-network
|
||||
shortTitle: Use GitHub-hosted runners
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
title: Monitoring your current jobs
|
||||
shortTitle: Monitor current jobs
|
||||
intro: 'Monitor how {% data variables.product.prodname_dotcom %}-hosted runners are processing jobs in your organization or enterprise, and identify any related constraints.'
|
||||
versions:
|
||||
feature: github-runner-dashboard
|
||||
shortTitle: Monitoring your current jobs
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Assigning permissions to jobs
|
||||
shortTitle: Assigning permissions to jobs
|
||||
shortTitle: Assign permissions to jobs
|
||||
intro: Modify the default permissions granted to `GITHUB_TOKEN`.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Choosing the runner for a job
|
||||
shortTitle: Choosing the runner for a job
|
||||
shortTitle: Choose the runner for a job
|
||||
intro: Define the type of machine that will process a job in your workflow.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Defining outputs for jobs
|
||||
shortTitle: Defining outputs for jobs
|
||||
shortTitle: Define outputs for jobs
|
||||
intro: Create a map of outputs for your jobs.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Running jobs in a container
|
||||
shortTitle: Running jobs in a container
|
||||
shortTitle: Run jobs in a container
|
||||
intro: Use a container to run the steps in a job.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Setting default values for jobs
|
||||
shortTitle: Setting default values for jobs
|
||||
shortTitle: Set default values for jobs
|
||||
intro: 'Define the default settings that will apply to all jobs in the workflow, or all steps in a job.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using a matrix for your jobs
|
||||
shortTitle: Using a matrix
|
||||
shortTitle: Matrixes
|
||||
intro: Create a matrix to define variations for each job.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using concurrency
|
||||
shortTitle: Using concurrency
|
||||
shortTitle: Concurrency
|
||||
intro: Run a single job at a time.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using conditions to control job execution
|
||||
shortTitle: Using conditions to control job execution
|
||||
shortTitle: Use conditions to control job execution
|
||||
intro: Prevent a job from running unless your conditions are met.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using environments for jobs
|
||||
shortTitle: Using environments for jobs
|
||||
shortTitle: Environments
|
||||
intro: Specify an environment for a job.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Using jobs in a workflow
|
||||
shortTitle: Using jobs in a workflow
|
||||
shortTitle: Use jobs in a workflow
|
||||
intro: Use workflows to run multiple jobs.
|
||||
versions:
|
||||
fpt: '*'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Caching dependencies to speed up workflows
|
||||
shortTitle: Caching dependencies
|
||||
shortTitle: Cache dependencies
|
||||
intro: 'To make your workflows faster and more efficient, you can create and use caches for dependencies and other commonly reused files.'
|
||||
redirect_from:
|
||||
- /github/automating-your-workflow-with-github-actions/caching-dependencies-to-speed-up-workflows
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Storing workflow data as artifacts
|
||||
shortTitle: Storing workflow artifacts
|
||||
shortTitle: Store artifacts
|
||||
intro: Artifacts allow you to share data between jobs in a workflow and store data once that workflow has completed.
|
||||
redirect_from:
|
||||
- /articles/persisting-workflow-data-using-artifacts
|
||||
|
||||
@@ -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: '*'
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
---
|
||||
title: Using starter workflows
|
||||
shortTitle: Use starter workflows
|
||||
intro: '{% data variables.product.product_name %} provides starter workflows for a variety of languages and tooling.'
|
||||
redirect_from:
|
||||
- /articles/setting-up-continuous-integration-using-github-actions
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -41,13 +41,6 @@ The default container image that's used by {% data variables.product.prodname_gi
|
||||
|
||||
1. In the {% data variables.product.prodname_vscode_shortname %} editor, close any "Get Started" tabs that are displayed.
|
||||
1. Open the `image-classifier.ipynb` notebook file.
|
||||
1. Click the Python kernel link at the top right of the editor.
|
||||
|
||||
|
||||
|
||||
1. In the drop-down menu, choose the kernel in the directory `/opt/python/latest/bin/python`.
|
||||
|
||||
|
||||
|
||||
### Build the image classifier
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.**
|
||||
|
||||
|
||||
|
||||
* In the VS Code desktop application, click **Building codespace** in the "Setting up remote connection" that's displayed.
|
||||
|
||||
|
||||
|
||||
{% 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.
|
||||
|
||||
@@ -58,36 +58,36 @@ You can select permissions in a query string using the permission name in the fo
|
||||
|
||||
Permission | Description
|
||||
---------- | -----------
|
||||
[`administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-administration) | Grants access to various endpoints for organization and repository administration. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %}
|
||||
[`blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-blocking) | Grants access to the [Blocking Users API](/rest/reference/users#blocking). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`checks`](/rest/reference/permissions-required-for-github-apps/#permission-on-checks) | Grants access to the [Checks API](/rest/reference/checks). Can be one of: `none`, `read`, or `write`.{% ifversion ghes < 3.4 %}
|
||||
[`administration`](/rest/reference/permissions-required-for-github-apps#administration) | Grants access to various endpoints for organization and repository administration. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %}
|
||||
[`blocking`](/rest/reference/permissions-required-for-github-apps#blocking-users) | Grants access to the [Blocking Users API](/rest/reference/users#blocking). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`checks`](/rest/reference/permissions-required-for-github-apps#checks) | Grants access to the [Checks API](/rest/reference/checks). Can be one of: `none`, `read`, or `write`.{% ifversion ghes < 3.4 %}
|
||||
`content_references` | Grants access to the "[Create a content attachment](/rest/reference/apps#create-a-content-attachment)" endpoint. Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`contents`](/rest/reference/permissions-required-for-github-apps/#permission-on-contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`.
|
||||
[`deployments`](/rest/reference/permissions-required-for-github-apps/#permission-on-deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghec %}
|
||||
[`emails`](/rest/reference/permissions-required-for-github-apps/#permission-on-emails) | Grants access to the [Emails API](/rest/reference/users#emails). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`followers`](/rest/reference/permissions-required-for-github-apps/#permission-on-followers) | Grants access to the [Followers API](/rest/reference/users#followers). Can be one of: `none`, `read`, or `write`.
|
||||
[`gpg_keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-gpg-keys) | Grants access to the [GPG Keys API](/rest/reference/users#gpg-keys). Can be one of: `none`, `read`, or `write`.
|
||||
[`issues`](/rest/reference/permissions-required-for-github-apps/#permission-on-issues) | Grants access to the [Issues API](/rest/reference/issues). Can be one of: `none`, `read`, or `write`.
|
||||
[`keys`](/rest/reference/permissions-required-for-github-apps/#permission-on-keys) | Grants access to the [Public Keys API](/rest/reference/users#keys). Can be one of: `none`, `read`, or `write`.
|
||||
[`members`](/rest/reference/permissions-required-for-github-apps/#permission-on-members) | Grants access to manage an organization's members. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %}
|
||||
[`metadata`](/rest/reference/permissions-required-for-github-apps/#metadata-permissions) | Grants access to read-only endpoints that do not leak sensitive data. Can be `read` or `none`. Defaults to `read` when you set any permission, or defaults to `none` when you don't specify any permissions for the {% data variables.product.prodname_github_app %}.
|
||||
[`organization_administration`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-administration) | Grants access to "[Update an organization](/rest/reference/orgs#update-an-organization)" endpoint and the [Organization Interaction Restrictions API](/rest/reference/interactions#set-interaction-restrictions-for-an-organization). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`organization_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-hooks) | Grants access to the [Organization Webhooks API](/rest/reference/orgs#webhooks/). Can be one of: `none`, `read`, or `write`.
|
||||
[`contents`](/rest/reference/permissions-required-for-github-apps#contents) | Grants access to various endpoints that allow you to modify repository contents. Can be one of: `none`, `read`, or `write`.
|
||||
[`deployments`](/rest/reference/permissions-required-for-github-apps#deployments) | Grants access to the [Deployments API](/rest/reference/repos#deployments). Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghes or ghec %}
|
||||
[`emails`](/rest/reference/permissions-required-for-github-apps#email-addresses) | Grants access to the [Emails API](/rest/reference/users#emails). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`followers`](/rest/reference/permissions-required-for-github-apps#followers) | Grants access to the [Followers API](/rest/reference/users#followers). Can be one of: `none`, `read`, or `write`.
|
||||
[`gpg_keys`](/rest/reference/permissions-required-for-github-apps#gpg-keys) | Grants access to the [GPG Keys API](/rest/reference/users#gpg-keys). Can be one of: `none`, `read`, or `write`.
|
||||
[`issues`](/rest/reference/permissions-required-for-github-apps#issues) | Grants access to the [Issues API](/rest/reference/issues). Can be one of: `none`, `read`, or `write`.
|
||||
[`keys`](/rest/reference/permissions-required-for-github-apps#git-ssh-keys) | Grants access to the [Public Keys API](/rest/reference/users#keys). Can be one of: `none`, `read`, or `write`.
|
||||
[`members`](/rest/reference/permissions-required-for-github-apps#members) | Grants access to manage an organization's members. Can be one of: `none`, `read`, or `write`.{% ifversion fpt or ghec %}
|
||||
[`metadata`](/rest/reference/permissions-required-for-github-apps#metadata) | Grants access to read-only endpoints that do not leak sensitive data. Can be `read` or `none`. Defaults to `read` when you set any permission, or defaults to `none` when you don't specify any permissions for the {% data variables.product.prodname_github_app %}.
|
||||
[`organization_administration`](/rest/reference/permissions-required-for-github-apps#organization-administration) | Grants access to "[Update an organization](/rest/reference/orgs#update-an-organization)" endpoint and the [Organization Interaction Restrictions API](/rest/reference/interactions#set-interaction-restrictions-for-an-organization). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`organization_hooks`](/rest/reference/permissions-required-for-github-apps#organization-webhooks) | Grants access to the [Organization Webhooks API](/rest/reference/orgs#webhooks/). Can be one of: `none`, `read`, or `write`.
|
||||
`organization_plan` | Grants access to get information about an organization's plan using the "[Get an organization](/rest/reference/orgs#get-an-organization)" endpoint. Can be one of: `none` or `read`.
|
||||
[`organization_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghec %}
|
||||
[`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps/#permission-on-organization-projects) | Grants access to the [Blocking Organization Users API](/rest/reference/orgs#blocking). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`pages`](/rest/reference/permissions-required-for-github-apps/#permission-on-pages) | Grants access to the [Pages API](/rest/reference/repos#pages). Can be one of: `none`, `read`, or `write`.
|
||||
[`organization_projects`](/rest/reference/permissions-required-for-github-apps#organization-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion fpt or ghec %}
|
||||
[`organization_user_blocking`](/rest/reference/permissions-required-for-github-apps#organization-user-blocking) | Grants access to the [Blocking Organization Users API](/rest/reference/orgs#blocking). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`pages`](/rest/reference/permissions-required-for-github-apps#pages) | Grants access to the [Pages API](/rest/reference/repos#pages). Can be one of: `none`, `read`, or `write`.
|
||||
`plan` | Grants access to get information about a user's GitHub plan using the "[Get a user](/rest/reference/users#get-a-user)" endpoint. Can be one of: `none` or `read`.
|
||||
[`pull_requests`](/rest/reference/permissions-required-for-github-apps/#permission-on-pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`.
|
||||
[`repository_hooks`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-hooks) | Grants access to the [Repository Webhooks API](/rest/reference/repos#hooks). Can be one of: `none`, `read`, or `write`.
|
||||
[`repository_projects`](/rest/reference/permissions-required-for-github-apps/#permission-on-repository-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion ghes or ghec %}
|
||||
[`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps/#permission-on-secret-scanning-alerts) | Grants access to the [Secret scanning API](/rest/reference/secret-scanning). Can be one of: `none`, `read`, or `write`.{% endif %}{% ifversion fpt or ghes or ghec %}
|
||||
[`security_events`](/rest/reference/permissions-required-for-github-apps/#permission-on-security-events) | Grants access to the [Code scanning API](/rest/reference/code-scanning/). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`single_file`](/rest/reference/permissions-required-for-github-apps/#permission-on-single-file) | Grants access to the [Contents API](/rest/reference/repos#contents). Can be one of: `none`, `read`, or `write`.
|
||||
[`starring`](/rest/reference/permissions-required-for-github-apps/#permission-on-starring) | Grants access to the [Starring API](/rest/reference/activity#starring). Can be one of: `none`, `read`, or `write`.
|
||||
[`statuses`](/rest/reference/permissions-required-for-github-apps/#permission-on-statuses) | Grants access to the [Statuses API](/rest/reference/commits#commit-statuses). Can be one of: `none`, `read`, or `write`.
|
||||
[`team_discussions`](/rest/reference/permissions-required-for-github-apps/#permission-on-team-discussions) | Grants access to the [Team Discussions API](/rest/reference/teams#discussions) and the [Team Discussion Comments API](/rest/reference/teams#discussion-comments). Can be one of: `none`, `read`, or `write`.
|
||||
`vulnerability_alerts`| Grants access to receive {% data variables.product.prodname_dependabot_alerts %} in a repository. See "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)" to learn more. Can be one of: `none` or `read`.
|
||||
[`pull_requests`](/rest/reference/permissions-required-for-github-apps#pull-requests) | Grants access to various pull request endpoints. Can be one of: `none`, `read`, or `write`.
|
||||
[`repository_hooks`](/rest/reference/permissions-required-for-github-apps#repository-webhooks) | Grants access to the [Repository Webhooks API](/rest/reference/repos#hooks). Can be one of: `none`, `read`, or `write`.
|
||||
[`repository_projects`](/rest/reference/permissions-required-for-github-apps#repository-projects) | Grants access to the [Projects API](/rest/reference/projects). Can be one of: `none`, `read`, `write`, or `admin`.{% ifversion ghes or ghec %}
|
||||
[`secret_scanning_alerts`](/rest/reference/permissions-required-for-github-apps#secret-scanning-alerts) | Grants access to the [Secret scanning API](/rest/reference/secret-scanning). Can be one of: `none`, `read`, or `write`.{% endif %}{% ifversion fpt or ghes or ghec %}
|
||||
[`security_events`](/rest/reference/permissions-required-for-github-apps#code-scanning-alerts) | Grants access to the [Code scanning API](/rest/reference/code-scanning/). Can be one of: `none`, `read`, or `write`.{% endif %}
|
||||
[`single_file`](/rest/reference/permissions-required-for-github-apps#single-file) | Grants access to the [Contents API](/rest/reference/repos#contents). Can be one of: `none`, `read`, or `write`.
|
||||
[`starring`](/rest/reference/permissions-required-for-github-apps#starring) | Grants access to the [Starring API](/rest/reference/activity#starring). Can be one of: `none`, `read`, or `write`.
|
||||
[`statuses`](/rest/reference/permissions-required-for-github-apps#commit-statuses) | Grants access to the [Statuses API](/rest/reference/commits#commit-statuses). Can be one of: `none`, `read`, or `write`.
|
||||
[`team_discussions`](/rest/reference/permissions-required-for-github-apps#team-discussions) | Grants access to the [Team Discussions API](/rest/reference/teams#discussions) and the [Team Discussion Comments API](/rest/reference/teams#discussion-comments). Can be one of: `none`, `read`, or `write`.
|
||||
[`vulnerability_alerts`](/rest/reference/permissions-required-for-github-apps#dependabot-alerts)| Grants access to receive {% data variables.product.prodname_dependabot_alerts %} in a repository. See "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)" to learn more. Can be one of: `none`, `read`, or `write`.
|
||||
`watching` | Grants access to list and change repositories a user is subscribed to. Can be one of: `none`, `read`, or `write`.
|
||||
|
||||
## {% data variables.product.prodname_github_app %} webhook events
|
||||
|
||||
@@ -18,7 +18,9 @@ topics:
|
||||
{% data reusables.user-settings.oauth_apps %}
|
||||
4. Select the {% data variables.product.prodname_oauth_app %} you want to modify.
|
||||
|
||||
5. Click **Delete application**.
|
||||
5. In the left sidebar, click **Advanced**.
|
||||
|
||||
6. Click **Delete application**.
|
||||
|
||||
6. Click **Delete this OAuth Application**.
|
||||
7. Click **Delete this OAuth Application**.
|
||||
|
||||
|
||||
@@ -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 %}
|
||||
|
||||
|
||||
@@ -48,10 +48,10 @@ If you need to distribute large files within your repository, you can create rel
|
||||
|
||||
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
|
||||
|
||||
We recommend repositories remain small, ideally less than 1 GB, and less than 5 GB is strongly recommended. 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.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -221,7 +221,7 @@ For Enterprise Marketing Pages, we may also use non-essential cookies to (i) ga
|
||||
|
||||
Our emails to users may contain a pixel tag, which is a small, clear image that can tell us whether or not you have opened an email and what your IP address is. We use this pixel tag to make our email communications more effective and to make sure we are not sending you unwanted email.
|
||||
|
||||
The length of time a cookie will stay on your browser or device depends on whether it is a “persistent” or “session” cookie. Session cookies will only stay on your device until you stop browsing. Persistent cookies stay until they expire or are deleted. The expiration time or retention period applicable to persistent cookies depends on the purpose of the cookie collection and tool used. You may be able to delete cookie data as described here.
|
||||
The length of time a cookie will stay on your browser or device depends on whether it is a “persistent” or “session” cookie. Session cookies will only stay on your device until you stop browsing. Persistent cookies stay until they expire or are deleted. The expiration time or retention period applicable to persistent cookies depends on the purpose of the cookie collection and tool used. You may be able to delete cookie data as described [here](/site-policy/privacy-policies/github-privacy-statement#what-are-your-cookie-choices-and-controls).
|
||||
|
||||
#### What are cookies and similar technologies?
|
||||
|
||||
@@ -372,9 +372,9 @@ The CCPA provides California residents with certain rights related to their pers
|
||||
When receiving a request, we will verify that the individual making the request is the resident to whom the personal information subject to the request pertains. California residents may exercise their rights themselves or may use an authorized agent, designated in writing or through a power of attorney, to make requests on their behalf. If you use an authorized agent to submit a request, we may require that you provide us additional information demonstrating that the agent is acting on your behalf, and we may need you to verify your identity directly with us.
|
||||
With respect to your personal information, California residents may exercise the rights described below.
|
||||
#### Right to Know.
|
||||
You have a right to request that we disclose to you the personal information we have collected about you. You also have a right to request additional information about our collection, use, disclosure, or sale of such personal information. Note that we have provided much of this information in this privacy statement. You can use GitHub’s User Migration API to access and download your data. Learn more here. You may also make such a “request to know” by contacting us here.
|
||||
You have a right to request that we disclose to you the personal information we have collected about you. You also have a right to request additional information about our collection, use, disclosure, or sale of such personal information. Note that we have provided much of this information in this privacy statement. You can use GitHub’s User Migration tool to access and download your data. Learn more [here](/get-started/privacy-on-github/requesting-an-archive-of-your-personal-accounts-data). You may also make such a “request to know” by contacting us [here](https://support.github.com/contact/privacy).
|
||||
#### Right to Request Deletion.
|
||||
You also have a right to request that we delete personal information under certain circumstances, subject to a number of exceptions. To make a request to delete, You can use GitHub’s User Migration API to access and download your data. Learn more here. You may also make such a “request to delete” by contacting us here.
|
||||
You also have a right to request that we delete personal information under certain circumstances, subject to a number of exceptions. To make a request to delete, you can contact us [here](https://support.github.com/contact/privacy) or use the account settings [here](https://github.com/settings/admin).
|
||||
|
||||
#### Right to Opt-Out.
|
||||
You have a right to opt-out from future “sales” of personal information. Note that we do not “sell” personal information as defined by the CCPA and have not done so in the past 12 months.
|
||||
|
||||
@@ -6,7 +6,7 @@ jobs:
|
||||
call-workflow-passing-data:
|
||||
uses: octo-org/example-repo/.github/workflows/reusable-workflow.yml@main
|
||||
with:
|
||||
username: mona
|
||||
config-path: .github/labeler.yml
|
||||
secrets:
|
||||
envPAT: ${{ secrets.envPAT }}
|
||||
```
|
||||
@@ -21,7 +21,7 @@ jobs:
|
||||
call-workflow-passing-data:
|
||||
uses: octo-org/example-repo/.github/workflows/reusable-workflow.yml@main
|
||||
with:
|
||||
username: mona
|
||||
config-path: .github/labeler.yml
|
||||
secrets: inherit
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
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.
|
||||
@@ -200934,7 +200934,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results only include open pull requests.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -252449,7 +252449,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List issues in a repository.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
@@ -201361,7 +201361,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results only include open pull requests.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -253811,7 +253811,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List issues in a repository.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
@@ -201525,7 +201525,7 @@
|
||||
}
|
||||
}
|
||||
],
|
||||
"descriptionHTML": "<p>List issues in a repository.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
@@ -148083,7 +148083,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results only include open pull requests.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -202409,7 +202409,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List issues in a repository.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
@@ -153493,7 +153493,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results only include open pull requests.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -210094,7 +210094,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List issues in a repository.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
@@ -160637,7 +160637,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results only include open pull requests.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -217250,7 +217250,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List issues in a repository.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
@@ -163415,7 +163415,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.</p>",
|
||||
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results only include open pull requests.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
@@ -222749,7 +222749,7 @@
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>List issues in a repository.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user