text stringlengths 12 91.7k | metadata dict |
|---|---|
Prerequisites
You should be familiar with the syntax for . For more information, see AUTOTITLE.
Triggering your deployment
You can use a variety of events to trigger your deployment workflow. Some of the most common are: pullrequest, push, and workflowdispatch.
For example, a workflow with the following triggers runs ... | {
"source": "github-docs/actions/how-tos/deploy/configure-and-manage-deployments/control-deployments.md",
"title": "Deploying with GitHub Actions"
} |
Prerequisites
For general information about deployment protection rules, see AUTOTITLE.
Creating a custom deployment protection rule with
1. Create a . For more information, see AUTOTITLE. Configure the as follows.
1. Optionally, in the Callback URL text field under "Identifying and authorizing users," enter the ... | {
"source": "github-docs/actions/how-tos/deploy/configure-and-manage-deployments/create-custom-protection-rules.md",
"title": "Creating custom deployment protection rules"
} |
Prerequisites
[!NOTE]
Users with plans can only configure environments for public repositories. If you convert a repository from public to private, any configured protection rules or environment secrets will be ignored, and you will not be able to configure any environments. If you convert your repository back to pu... | {
"source": "github-docs/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments.md",
"title": "Managing environments for deployment"
} |
Approving or rejecting a job
1. Navigate to the workflow run that requires review. For more information about navigating to a workflow run, see AUTOTITLE.
1. If the run requires review, you will see a notification for the review request. On the notification, click Review deployments.
1. Select the job environment(s) to... | {
"source": "github-docs/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments.md",
"title": "Reviewing deployments"
} |
Viewing your repository's deployment history
On the deployments page of your repository, you can view the following aspects of your deployments.
Currently active deployments across various environments
Deployments filtered by environment
Your repository's full deployment history
Associated commits that triggered th... | {
"source": "github-docs/actions/how-tos/deploy/configure-and-manage-deployments/view-deployment-history.md",
"title": "Viewing deployment history"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps for Amazon ECR and ECS:
1. Create an Amazon ECR repository to store your images.
For example, using the AWS CLI:
bash copy
aws ecr create-repository \
--repository-name MYECRREPOSITORY \
--regi... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/amazon-elastic-container-service.md",
"title": "Deploying to Amazon Elastic Container Service"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create a target AKS cluster and an Azure Container Registry (ACR). For more information, see Quickstart: Deploy an AKS cluster by using the Azure portal - Azure Kubernetes Service and Quickstart - Create registry... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-kubernetes-service.md",
"title": "Deploying to Azure Kubernetes Service"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create an Azure Static Web App using the 'Other' option for deployment source. For more information, see Quickstart: Building your first static site in the Azure portal in the Azure documentation.
1. Create a sec... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/azure-static-web-app.md",
"title": "Deploying to Azure Static Web App"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app:
shell copy
az webapp create \
--name MYWEBAPPNAME \
--plan MYAPPSERVICEPLAN \
--resou... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/docker-to-azure-app-service.md",
"title": "Deploying Docker to Azure App Service"
} |
Prerequisites
Before you proceed with creating the workflow, you will need to complete the following steps for your Kubernetes project. This guide assumes the root of your project already has a Dockerfile and a Kubernetes Deployment configuration file.
Creating a GKE cluster
To create the GKE cluster, you will first n... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/google-kubernetes-engine.md",
"title": "Deploying to Google Kubernetes Engine"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a Java runtime:
bash copy
az webapp create \
--name MYWEBAPPNAME \
--plan MYAPPSERVICEPL... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/java-to-azure-app-service.md",
"title": "Deploying Java to Azure App Service"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a .NET runtime:
bash copy
az webapp create \
--name MYWEBAPPNAME \
--plan MYAPPSERVICEPL... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/net-to-azure-app-service.md",
"title": "Deploying .NET to Azure App Service"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime:
bash copy
az webapp create \
--name MYWEBAPPNAME \
--plan MYAPPSERVIC... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/nodejs-to-azure-app-service.md",
"title": "Deploying Node.js to Azure App Service"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a PHP runtime:
bash copy
az webapp create \
--name MYWEBAPPNAME \
--plan MYAPPSERVICEPLA... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/php-to-azure-app-service.md",
"title": "Deploying PHP to Azure App Service"
} |
Prerequisites
Before creating your workflow, you will first need to complete the following setup steps:
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a Python runtime:
bash copy
az webapp create \
--name MYWEBAPPNAME \
--plan MYAPPSERVICE... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/python-to-azure-app-service.md",
"title": "Deploying Python to Azure App Service"
} |
Prerequisites
You should be familiar with YAML and the syntax for . For more information, see:
AUTOTITLE
AUTOTITLE
You should have an understanding of Xcode app building and signing. For more information, see the Apple developer documentation.
Creating secrets for your certificate and provisioning profile
The signin... | {
"source": "github-docs/actions/how-tos/deploy/deploy-to-third-party-platforms/sign-xcode-applications.md",
"title": "Installing an Apple certificate on macOS runners for Xcode development"
} |
You can contact for assistance with .
Providing diagnostic and troubleshooting information
The contents of private and internal repositories are not visible to , so may request additional information to understand the complete context of your inquiry and reproduce any unexpected behavior. You can accelerate the reso... | {
"source": "github-docs/actions/how-tos/get-support.md",
"title": "Getting help from GitHub Support about GitHub Actions"
} |
Using an API gateway with OIDC
For example, you could run an API gateway on the edge of your private network that authenticates incoming requests with the OIDC token and then makes API requests on behalf of your workflow in your private network.
The following diagram gives an overview of this solution's architecture:
... | {
"source": "github-docs/actions/how-tos/manage-runners/github-hosted-runners/connect-to-a-private-network/connect-with-oidc.md",
"title": "Using an API gateway with OIDC"
} |
Using WireGuard to create a network overlay
There are various disadvantages to this approach:
To reach WireGuard running on your private service, you will need a well-known IP address and port that your workflow can reference: this can either be a public IP address and port, a port mapping on a network gateway, or a s... | {
"source": "github-docs/actions/how-tos/manage-runners/github-hosted-runners/connect-to-a-private-network/connect-with-wireguard.md",
"title": "Using WireGuard to create a network overlay"
} |
If you require additional software packages on -hosted runners, you can create a job that installs the packages as part of your workflow.
To see which packages are already installed by default, see AUTOTITLE.
This guide demonstrates how to create a job that installs additional software on a -hosted runner.
Installing ... | {
"source": "github-docs/actions/how-tos/manage-runners/github-hosted-runners/customize-runners.md",
"title": "Customizing GitHub-hosted runners"
} |
Using a -hosted runner
To use a -hosted runner, create a job and use runs-on to specify the type of runner that will process the job, such as ubuntu-latest, windows-latest, or macos-latest. For the full list of runner types, see AUTOTITLE. If you have repo: write access to a repository, you can view a list of the runne... | {
"source": "github-docs/actions/how-tos/manage-runners/github-hosted-runners/use-github-hosted-runners.md",
"title": "Using GitHub-hosted runners"
} |
Viewing active jobs in your organization or enterprise
You can get a list of all jobs currently running on -hosted runners in your organization or enterprise.
1. Review the "Active jobs" section, which contains a list of all jobs currently running on -hosted runners.
Viewing queued jobs in your organization or enterpr... | {
"source": "github-docs/actions/how-tos/manage-runners/github-hosted-runners/view-current-jobs.md",
"title": "Viewing your current jobs"
} |
Managing access to larger runners
[!NOTE]
Before your workflows can send jobs to s, you must first configure permissions for the runner group. See the following sections for more information.
Runner groups are used to control which repositories can run jobs on your s. You must manage access to the group from each lev... | {
"source": "github-docs/actions/how-tos/manage-runners/larger-runners/control-access.md",
"title": "Controlling access to larger runners"
} |
Adding a to an enterprise
Enterprise owners can add s to an enterprise and assign them to organizations. By default, when a is created for an enterprise, it is added to a default runner group that all organizations in the enterprise have access to. While all organizations are granted access to the runner, the reposit... | {
"source": "github-docs/actions/how-tos/manage-runners/larger-runners/manage-larger-runners.md",
"title": "Managing larger runners"
} |
Custom images
You can create a custom image to define the exact environment that your use. Custom images let you preinstall tools, dependencies, and configurations to speed up workflows and improve consistency across jobs.
When your runner uses a custom image, it acts as a “pre-warmed” environment, allowing workflows ... | {
"source": "github-docs/actions/how-tos/manage-runners/larger-runners/use-custom-images.md",
"title": "Using custom images"
} |
Identifying available runners for a repository
1. Review the list of available runners for the repository.
Targeting larger runners in a workflow
After you identify the s you want to use, you can target them in your workflow with runner groups, workflow labels, or both. Use runner groups to route jobs to a set of runn... | {
"source": "github-docs/actions/how-tos/manage-runners/larger-runners/use-larger-runners.md",
"title": "Running jobs on larger runners"
} |
[!WARNING]
For more information, see AUTOTITLE.
Prerequisites
Before you add a self-hosted runner, you should understand what they are and how they work. See AUTOTITLE.
Additionally, you must meet the following requirements:
Adding a self-hosted runner to a repository
You can add self-hosted runners to a single repo... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/add-runners.md",
"title": "Adding self-hosted runners"
} |
For information on how to use labels to route jobs to specific types of self-hosted runners, see AUTOTITLE. You can also route jobs to runners in a specific group. For more information, see AUTOTITLE.
Creating a custom label
You can create custom labels for runners at the repository, organization, and enterprise and o... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/apply-labels.md",
"title": "Using labels with self-hosted runners"
} |
1. Stop the self-hosted runner application if it is currently running.
On the runner machine, open a shell in the directory where you installed the self-hosted runner application. Use the commands below to install and manage the self-hosted runner service.
[!NOTE]
You must add a runner to before you can configure th... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/configure-the-application.md",
"title": "Configuring the self-hosted runner application as a service"
} |
[!NOTE]
This feature is currently in and is subject to change.
About container customization
allows you to run a job within a container, using the container: statement in your workflow file. For more information, see AUTOTITLE. To process container-based jobs, the self-hosted runner creates a container for each job... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/customize-containers.md",
"title": "Customizing the containers used by jobs"
} |
Creating a self-hosted runner group for an organization
Creating a self-hosted runner group for an enterprise
Changing which organizations can access a runner group
For runner groups in an enterprise, you can change what organizations in the enterprise can access a runner group.
Changing which repositories can acces... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/manage-access.md",
"title": "Managing access to self-hosted runners using groups"
} |
Checking access levels
You may not be able to create a self-hosted runner for an organization-owned repository.
Checking the status of a self-hosted runner
1. Under "Runners", you can view a list of registered runners, including the runner's name, labels, and status.
The status can be one of the following:
Id... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot.md",
"title": "Monitoring and troubleshooting self-hosted runners"
} |
Name Status
---- ------
actions.runner.octo-org-octo-repo.runner01.service Running
You can use PowerShell to check the recent activity of the self-hosted runner. In this example output, you can see the application start... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/monitor-and-troubleshoot.md",
"title": "Monitoring and troubleshooting self-hosted runners"
} |
Removing a runner from a repository
[!NOTE]
To remove a self-hosted runner from a user repository you must be the repository owner. Organization owners and users with the "Manage organization runners and runner groups" permission can remove a runner from a repository in the organization. For more information about cus... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/remove-runners.md",
"title": "Removing self-hosted runners"
} |
About pre- and post-job scripts
You can automatically execute scripts on a self-hosted runner, either before a job runs, or after a job finishes running. You could use these scripts to support the job's requirements, such as building or tearing down a runner environment, or cleaning out directories. You could also use ... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/run-scripts.md",
"title": "Running scripts before or after a job"
} |
Viewing available runners for a repository
1. Click the Self hosted tab at the top of the list of runners.
1. Review the list of available self-hosted runners for the repository. This list includes both self-hosted runners and runner scale sets created with . For more information, see AUTOTITLE.
Using default labels t... | {
"source": "github-docs/actions/how-tos/manage-runners/self-hosted-runners/use-in-a-workflow.md",
"title": "Using self-hosted runners in a workflow"
} |
You can authenticate (ARC) to the API by using a or by using a .
[!NOTE]
You cannot authenticate using a for runners at the enterprise level. For more information, see AUTOTITLE.
Authenticating ARC with a
1. Create a that is owned by an organization. For more information, see AUTOTITLE. Configure the as follo... | {
"source": "github-docs/actions/how-tos/manage-runners/use-actions-runner-controller/authenticate-to-the-api.md",
"title": "Authenticating ARC to the GitHub API"
} |
Deploying a runner scale set
To deploy a runner scale set, you must have ARC up and running. For more information, see AUTOTITLE.
You can deploy runner scale sets with ARC's Helm charts or by deploying the necessary manifests. Using ARC's Helm charts is the preferred method, especially if you do not have prior experien... | {
"source": "github-docs/actions/how-tos/manage-runners/use-actions-runner-controller/deploy-runner-scale-sets.md",
"title": "Deploying runner scale sets with Actions Runner Controller"
} |
Using ARC runners in a workflow file
To assign jobs to run on a runner scale set, you can specify the name of the scale set as the value for the runs-on key in your workflow file.
For example, the following configuration for a runner scale set has the INSTALLATIONNAME value set to arc-runner-set.
# Using a {% data var... | {
"source": "github-docs/actions/how-tos/manage-runners/use-actions-runner-controller/use-arc-in-a-workflow.md",
"title": "Using Actions Runner Controller runners in a workflow"
} |
Configuring a proxy for Linux and Windows runners
If your runner needs to communicate via a proxy server, you can configure proxy settings using environment variables or system-level configurations.
The proxy environment variables are read when the runner application starts, so you must set the environment variables be... | {
"source": "github-docs/actions/how-tos/manage-runners/use-proxy-servers.md",
"title": "Using proxy servers with a runner"
} |
Workflow runs triggered by a contributor's pull request from a fork may require manual approval from a maintainer with write access. You can configure workflow approval requirements for a repository, organization, or enterprise.
Workflow runs that have been awaiting approval for more than 30 days are automatically dele... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/approve-runs-from-forks.md",
"title": "Approving workflow runs from forks"
} |
Canceling a workflow run
1. From the list of workflow runs, click the name of the queued or in progress run that you want to cancel.
1. In the upper-right corner of the workflow, click Cancel workflow.
Next steps
To learn about the process uses to cancel a workflow run, as well as the ways you can free up related res... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/cancel-a-workflow-run.md",
"title": "Canceling a workflow run"
} |
1. To delete a workflow run, select , then click Delete workflow run.
!Screenshot of a list of workflow runs. To the right of a run, an icon of three horizontal dots is highlighted with an orange outline.
1. Review the confirmation prompt and click Yes, permanently delete this workflow run. | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/delete-a-workflow-run.md",
"title": "Deleting a workflow run"
} |
Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on .
Temporarily disabling a workflow can be useful in many scenarios. These are a few examples where disabling a workflow might be helpful:
A workflow er... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/disable-and-enable-workflows.md",
"title": "Disabling and enabling a workflow"
} |
By default, stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see AUTOTITLE.
1. In the "Artifacts" section, click the artifact you want to download.
!Screenshot of the "Artifacts" section of a workflow run. The name ... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/download-workflow-artifacts.md",
"title": "Downloading workflow artifacts"
} |
This article describes managing caches with the web interface, but you can also manage them:
Using the REST API. See AUTOTITLE.
With the gh cache subcommand from the command line. See the GitHub CLI documentation.
Viewing cache entries
You can use the web interface to view a list of cache entries for a repository. ... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/manage-caches.md",
"title": "Managing caches"
} |
Configuring a workflow to run manually
To run a workflow manually, the workflow must be configured to run on the workflowdispatch event.
To trigger the workflowdispatch event, your workflow must be in the default branch. For more information about configuring the workflowdispatch event, see AUTOTITLE.
Running a workfl... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/manually-run-a-workflow.md",
"title": "Manually running a workflow"
} |
Re-runs use the privileges of the actor who initially triggered the workflow, not the privileges of the actor who initiated the re-run. The workflow will also use the same GITHUBSHA (commit SHA) and GITHUBREF (git ref) of the original event that triggered the workflow run.
A workflow run can be re-run a maximum of 50 t... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/re-run-workflows-and-jobs.md",
"title": "Re-running workflows and jobs"
} |
Deleting an artifact
[!WARNING]
Once you delete an artifact, it cannot be restored.
1. Under Artifacts, click next to the artifact you want to remove.
!Screenshot showing artifacts created during a workflow run. A trash can icon, used to remove an artifact, is outlined in dark orange.
Setting the retention peri... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/remove-workflow-artifacts.md",
"title": "Removing workflow artifacts"
} |
[!NOTE]
If a workflow is skipped due to path filtering, branch filtering or a commit message (see below), then checks associated with that workflow will remain in a "Pending" state. A pull request that requires those checks to be successful will be blocked from merging.
Workflows that would otherwise be triggered usin... | {
"source": "github-docs/actions/how-tos/manage-workflow-runs/skip-workflow-runs.md",
"title": "Skipping workflow runs"
} |
[!NOTE]
Workflow badges in a private repository are not accessible externally, so you won't be able to embed them or link to them from an external site.
To add a workflow status badge to your README.md file, first find the URL for the status badge you would like to display. Then you can use Markdown to display the bad... | {
"source": "github-docs/actions/how-tos/monitor-workflows/add-a-status-badge.md",
"title": "Adding a workflow status badge"
} |
These extra logs are enabled by setting secrets or variables in the repository containing the workflow, so the same permissions requirements will apply:
For more information on setting secrets and variables, see AUTOTITLE and AUTOTITLE.
Additionally, anyone who has access to run a workflow can enable runner diagnostic ... | {
"source": "github-docs/actions/how-tos/monitor-workflows/enable-debug-logging.md",
"title": "Enabling debug logging"
} |
1. The graph displays each job in the workflow. An icon to the left of the job name indicates the status of the job. Lines between jobs indicate dependencies.
!Screenshot of the visualization graph of a workflow run.
1. To view a job's log, click the job. | {
"source": "github-docs/actions/how-tos/monitor-workflows/use-the-visualization-graph.md",
"title": "Using the visualization graph"
} |
You can see whether a workflow run is in progress or complete from the workflow run page. You must be logged in to a account to view workflow run information, including for public repositories. For more information, see AUTOTITLE.
If the run is complete, you can see whether the result was a success, failure, canceled,... | {
"source": "github-docs/actions/how-tos/monitor-workflows/use-workflow-run-logs.md",
"title": "Using workflow run logs"
} |
When a job's if condition is evaluated, logs the expression evaluation to help you understand the result. This is useful for debugging both why a job was skipped and why a job ran when you expected it to be skipped.
Accessing expression logs
1. Navigate to the workflow run summary.
1. Click on the job.
1. Click .
1. ... | {
"source": "github-docs/actions/how-tos/monitor-workflows/view-job-condition-logs.md",
"title": "Viewing job condition expression logs"
} |
Billable job execution minutes are only shown for jobs run on private repositories that use -hosted runners and are rounded up to the next minute. There are no billable minutes when using in public repositories or for jobs run on self-hosted runners.
1. Under the job summary, you can view the job's execution time.
1. ... | {
"source": "github-docs/actions/how-tos/monitor-workflows/view-job-execution-time.md",
"title": "Viewing job execution time"
} |
Viewing recent workflow runs
To list the recent workflow runs, use the run list subcommand.
gh run list
To specify the maximum number of runs to return, you can use the -L or --limit flag . The default is 10.
gh run list --limit 5
To only return runs for the specified workflow, you can use the -w or --workflow flag. Re... | {
"source": "github-docs/actions/how-tos/monitor-workflows/view-workflow-run-history.md",
"title": "Viewing workflow run history"
} |
Creating workflow templates
This procedure demonstrates how to create a workflow template and metadata file. The metadata file describes how the workflow templates will be presented to users when they are creating a new workflow.
1. If it doesn't already exist, create a new public repository named .github in your orga... | {
"source": "github-docs/actions/how-tos/reuse-automations/create-workflow-templates.md",
"title": "Creating workflow templates for your organization"
} |
Creating a reusable workflow
Reusable workflows are YAML-formatted files, very similar to any other workflow file. As with other workflow files, you locate reusable workflows in the .github/workflows directory of a repository. Subdirectories of the workflows directory are not supported.
You can standardize deployments ... | {
"source": "github-docs/actions/how-tos/reuse-automations/reuse-workflows.md",
"title": "Reuse workflows"
} |
[!WARNING]
Sharing actions and workflows from your private repository
1. Store the action or reusable workflow in a private repository. For more information, see AUTOTITLE.
1. On , navigate to the main page of the private repository.
1. Under your repository name, click Settings.
1. To grant access to other private r... | {
"source": "github-docs/actions/how-tos/reuse-automations/share-across-private-repositories.md",
"title": "Sharing actions and workflows from your private repository"
} |
Overview
If your organization is owned by an enterprise account, you can share actions and reusable workflows within your enterprise, without publishing them publicly, by allowing workflows to access an internal or private repository that contains the action or reusable workflow.
Any actions or reusable workflows stor... | {
"source": "github-docs/actions/how-tos/reuse-automations/share-with-your-enterprise.md",
"title": "Sharing actions and workflows with your enterprise"
} |
[!WARNING]
Sharing actions and workflows with your organization
1. Store the action or reusable workflow in a private repository. For more information, see AUTOTITLE.
1. On , navigate to the main page of the private repository.
1. Under your repository name, click Settings.
1. To grant access to other private reposit... | {
"source": "github-docs/actions/how-tos/reuse-automations/share-with-your-organization.md",
"title": "Sharing actions and workflows with your organization"
} |
Overview
OpenID Connect (OIDC) allows your workflows to access resources in Amazon Web Services (AWS), without needing to store the AWS credentials as long-lived secrets.
This guide explains how to configure AWS to trust 's OIDC as a federated identity, and includes a workflow example for the aws-actions/configure-aw... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-aws.md",
"title": "Configuring OpenID Connect in Amazon Web Services"
} |
Overview
OpenID Connect (OIDC) allows your workflows to access resources in Azure, without needing to store the Azure credentials as long-lived secrets.
This guide gives an overview of how to configure Azure to trust 's OIDC as a federated identity, and includes a workflow example for the azure/login action that uses... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-azure.md",
"title": "Configuring OpenID Connect in Azure"
} |
Overview
OpenID Connect (OIDC) allows your workflows to access resources in your cloud provider, without having to store any credentials as long-lived secrets.
To use OIDC, you will first need to configure your cloud provider to trust 's OIDC as a federated identity, and must then update your workflows to authenticat... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-cloud-providers.md",
"title": "Configuring OpenID Connect in cloud providers"
} |
Overview
OpenID Connect (OIDC) allows your workflows to access resources in Google Cloud Platform (GCP), without needing to store the GCP credentials as long-lived secrets.
This guide gives an overview of how to configure GCP to trust 's OIDC as a federated identity, and includes a workflow example for the google-git... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-google-cloud-platform.md",
"title": "Configuring OpenID Connect in Google Cloud Platform"
} |
Overview
OpenID Connect (OIDC) allows your workflows to authenticate with a HashiCorp Vault to retrieve secrets.
This guide gives an overview of how to configure HashiCorp Vault to trust 's OIDC as a federated identity, and demonstrates how to use this configuration in the hashicorp/vault-action action to retrieve sec... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-hashicorp-vault.md",
"title": "Configuring OpenID Connect in HashiCorp Vault"
} |
Overview
OpenID Connect (OIDC) allows your workflows to authenticate with JFrog to download and publish artifacts without storing JFrog passwords, tokens, or API keys in .
This guide gives an overview of how to configure JFrog to trust 's OIDC as a federated identity, and demonstrates how to use this configuration in ... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-jfrog.md",
"title": "Configuring OpenID Connect in JFrog"
} |
Overview
OpenID Connect (OIDC) allows your workflows to authenticate with Octopus Deploy to push packages, create releases or trigger deployments without storing Octopus Deploy passwords or API keys as long-lived secrets.
This guide provides an overview of how to configure Octopus Deploy to trust 's OIDC as a federat... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-octopus-deploy.md",
"title": "Configuring OpenID Connect in Octopus Deploy"
} |
Overview
OpenID Connect (OIDC) allows your workflows to authenticate with PyPI to publish Python packages.
This guide gives an overview of how to configure PyPI to trust 's OIDC as a federated identity, and demonstrates how to use this configuration in the pypa/gh-action-pypi-publish action to publish packages to PyPI... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-pypi.md",
"title": "Configuring OpenID Connect in PyPI"
} |
About reusable workflows
Rather than copying and pasting deployment jobs from one workflow to another, you can create a reusable workflow that performs the deployment steps. A reusable workflow can be used by another workflow if it meets one of the access requirements described in AUTOTITLE.
You should be familiar with... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-with-reusable-workflows.md",
"title": "Using OpenID Connect with reusable workflows"
} |
Filtering for reusable workflows within a specific repository
You can configure a custom claim that filters for any reusable workflow in a specific repository. In this example, the workflow run must have originated from a job defined in a reusable workflow in the octo-org/octo-automation repository, and in any reposito... | {
"source": "github-docs/actions/how-tos/secure-your-work/security-harden-deployments/oidc-with-reusable-workflows.md",
"title": "Using OpenID Connect with reusable workflows"
} |
[!NOTE] Before proceeding, ensure you have enabled build provenance for container images, including setting the push-to-registry attribute in the attest action as documented in Generating build provenance for container images. This is required for the Policy Controller to verify the attestation.
Getting started with K... | {
"source": "github-docs/actions/how-tos/secure-your-work/use-artifact-attestations/enforce-artifact-attestations.md",
"title": "Enforcing artifact attestations with a Kubernetes admission controller"
} |
Prerequisites
Before starting this guide, you should be familiar with:
The usage and security benefits of artifact attestations. See AUTOTITLE.
Generating artifact attestations. See AUTOTITLE.
Writing and using reusable workflows. See AUTOTITLE.
Step 1: Configuring your builds
First, we need to build with both arti... | {
"source": "github-docs/actions/how-tos/secure-your-work/use-artifact-attestations/increase-security-rating.md",
"title": "Using artifact attestations and reusable workflows to achieve SLSA v1 Build Level 3"
} |
Finding attestations
1. Navigate to the repository where the attestation was produced.
1. In the left sidebar, under "Management," click Attestations.
1. The attestations are sorted by creation date, newest first. Use the "Search or filter" bar to search for an attestation or filter the results.
Searching and filteri... | {
"source": "github-docs/actions/how-tos/secure-your-work/use-artifact-attestations/manage-attestations.md",
"title": "Managing the lifecycle of artifact attestations"
} |
Prerequisites
Before you start generating artifact attestations, you need to understand what they are and when you should use them. See AUTOTITLE.
Generating artifact attestations for your builds
You can use to generate artifact attestations that establish build provenance for artifacts such as binaries and container... | {
"source": "github-docs/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations.md",
"title": "Using artifact attestations to establish provenance for builds"
} |
Prerequisites
Before starting this guide, you should be generating artifact attestations for your builds. See AUTOTITLE.
Step 1: Download attestation bundle
First, get the attestation bundle from the attestation API.
You can do so with the following command from a machine that is online:
gh attestation download PATH/T... | {
"source": "github-docs/actions/how-tos/secure-your-work/use-artifact-attestations/verify-attestations-offline.md",
"title": "Verifying attestations offline"
} |
Any previous content has been overwritten
The trusted metadata is now available at sha256:ae57936def59bc4c75edd3a837d89bcefc6d3a5e31d55a6fa7a71624f92c3c3b.jsonl
Step 2: Download trusted roots
Next, get the key material from the trusted roots.
Artifact attestations uses the Sigstore public good instance for public repo... | {
"source": "github-docs/actions/how-tos/secure-your-work/use-artifact-attestations/verify-attestations-offline.md",
"title": "Verifying attestations offline"
} |
Initial troubleshooting suggestions
There are several ways you can troubleshoot failed workflow runs.
[!NOTE] If you are on a subscription, this will count towards your monthly chat message limit.
Using
To open a chat with about a failed workflow run, you can either:
Next to the failed check in the merge box, clic... | {
"source": "github-docs/actions/how-tos/troubleshoot-workflows.md",
"title": "Troubleshooting workflows"
} |
You can use a workflow to run scripts and shell commands, which are then executed on the assigned runner. This example demonstrates how to use the run keyword to execute the command npm install -g bats on the runner.
jobs:
example-job:
runs-on: ubuntu-latest
steps:
- run: npm install -g bats
To use a w... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/add-scripts.md",
"title": "Adding scripts to your workflow"
} |
Prerequisites
You need to create an environment before you can use it in a workflow. See AUTOTITLE.
Using an environment in a workflow
1. Open the workflow file you want to edit.
1. Use the following syntax to add a jobs.<jobid.environment key to your workflow:
yaml copy
jobs:
JOB-ID:
environment... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/deploy-to-environment.md",
"title": "Deploying to a specific environment"
} |
Browsing Marketplace actions in the workflow editor
You can search and browse actions directly in your repository's workflow editor. From the sidebar, you can search for a specific action, view featured actions, and browse featured categories. You can also view the number of stars an action has received from the commu... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/find-and-customize-actions.md",
"title": "Using pre-written building blocks in your workflow"
} |
Defining and using job outputs
1. Open the workflow file containing the job you want to get outputs from.
1. Use the jobs.<jobid.outputs syntax to define the outputs for the job. For example, the following job defines the output1 and output2 outputs, which are mapped to the results of step1 and step2 respectively:
y... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/pass-job-outputs.md",
"title": "Passing information between jobs"
} |
About matrix strategies
Adding a matrix strategy to your workflow job
Use jobs.<jobid.strategy.matrix to define a matrix of different job configurations. Within your matrix, define one or more variables followed by an array of values. For example, the following matrix has a variable called version with the value [10, ... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/run-job-variations.md",
"title": "Running variations of jobs in a workflow"
} |
Overview
Setting default shell and working directory
Setting default values for a specific job
Setting default shell and working directory for a job
Example: Setting default run step options for a job | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/set-default-values-for-jobs.md",
"title": "Setting a default shell and working directory"
} |
is preinstalled on all -hosted runners. For each step that uses , you must set an environment variable called GHTOKEN to a token with the required scopes.
You can execute any command. For example, this workflow uses the gh issue comment subcommand to add a comment when an issue is opened.
name: Comment when opened
on:... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/use-github-cli.md",
"title": "Using GitHub CLI in workflows"
} |
Prerequisites
To implement jobs in your workflows, you need to understand what jobs are. See AUTOTITLE.
Setting an ID for a job
Setting a name for a job
Defining prerequisite jobs
Using a matrix to run jobs with different variables
To automatically run a job with different combinations of variables, such as operati... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/use-jobs.md",
"title": "Using jobs in a workflow"
} |
Creating secrets for a repository
!Screenshot of the "Actions secrets and variables" page. The "Secrets" tab is outlined in dark orange.
1. Click New repository secret.
1. In the Name field, type a name for your secret.
1. In the Secret field, enter the value for your secret.
1. Click Add secret.
If your repository ... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets.md",
"title": "Using secrets in GitHub Actions"
} |
Defining environment variables for a single workflow
To set a custom environment variable for a single workflow, you can define it using the env key in the workflow file. The scope of a custom variable set by this method is limited to the element in which it is defined. You can define variables that are scoped for:
Th... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-what-workflows-do/use-variables.md",
"title": "Store information in variables"
} |
You can use the jobs.<jobid.if conditional to prevent a job from running unless a condition is met.
Example: Only run job for a specific repository
This example uses if to control when the production-deploy job can run. It will only run if the repository is named octo-repo-prod and is within the octo-org organization... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-when-workflows-run/control-jobs-with-conditions.md",
"title": "Using conditions to control job execution"
} |
Using concurrency in different scenarios
Monitoring your current jobs in your organization or enterprise | {
"source": "github-docs/actions/how-tos/write-workflows/choose-when-workflows-run/control-workflow-concurrency.md",
"title": "Control the concurrency of workflows and jobs"
} |
Prerequisites
To learn more about workflows and triggering workflows, see AUTOTITLE.
Triggering a workflow from a workflow
For more information, see AUTOTITLE.
If you do want to trigger a workflow from within a workflow run, you can use a installation access token or a instead of GITHUBTOKEN to trigger events that ... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow.md",
"title": "Triggering a workflow"
} |
Overview
Choosing -hosted runners
Choosing self-hosted runners
Choosing runners in a group | {
"source": "github-docs/actions/how-tos/write-workflows/choose-where-workflows-run/choose-the-runner-for-a-job.md",
"title": "Choosing the runner for a job"
} |
Overview
Dockerfile instructions and overrides
A Dockerfile contains instructions and arguments that define the contents and startup behavior of a Docker container. For more information about the instructions Docker supports, see Dockerfile reference in the Docker documentation.
Some Docker instructions interact with ... | {
"source": "github-docs/actions/how-tos/write-workflows/choose-where-workflows-run/run-jobs-in-a-container.md",
"title": "Running jobs in a container"
} |
Choosing and using a workflow template
1. The "Choose a workflow" page shows a selection of recommended workflow templates. Find the workflow template that you want to use, then click Configure. To help you find the workflow template that you want, you can search for keywords or filter by category.
1. If the workflow t... | {
"source": "github-docs/actions/how-tos/write-workflows/use-workflow-templates.md",
"title": "Using workflow templates"
} |
About custom transformers
offers the ability to extend its built-in mapping by creating custom transformers. Custom transformers can be used to:
Convert items that does not automatically convert, or modify how items are converted. For more information, see Creating custom transformers for items.
Convert references ... | {
"source": "github-docs/actions/reference/github-actions-importer/custom-transformers.md",
"title": "Extending GitHub Actions Importer with custom transformers"
} |
This article provides general information for configuring 's supplemental arguments and settings, such as optional parameters, path arguments, and network settings.
Optional parameters
has several optional parameters that you can use to customize the migration process.
Limiting allowed actions
The following options ... | {
"source": "github-docs/actions/reference/github-actions-importer/supplemental-arguments-and-settings.md",
"title": "Supplemental arguments and settings"
} |
You may be rate limited by when you scale your usage. Some limits can be increased by contacting .
Unless otherwise stated, the expected behavior when a limit is reached is that the workflow/job will get cancelled.
These limits are subject to change.
Existing system limits
Limit category Limit Threshold Descripti... | {
"source": "github-docs/actions/reference/limits.md",
"title": "Actions limits"
} |
Supported runners and hardware resources
Ranges of -hosted runners are available for use in public and private repositories.
For lists of available runners, see:
Standard runners for public repositories
Standard runners for private and internal repositoriesStandard runners for private repositories
-hosted Linux runne... | {
"source": "github-docs/actions/reference/runners/github-hosted-runners.md",
"title": "GitHub-hosted runners reference"
} |
For reference information about larger runners, see the documentation.
Machine sizes for
You can choose from several specifications for .
Specifications for general
CPU Memory (RAM) Storage (SSD) Architecture Operating system (OS)
--- ------------- ------------- ------------ ---------------------
5 ... | {
"source": "github-docs/actions/reference/runners/larger-runners.md",
"title": "Larger runners reference"
} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.