Skip to content

Repo sync #26261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,18 @@ When you watch a repository, you're subscribing to updates for activity in that
To see repositories that you're watching, go to your [watching page](https://github.com/watching). For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)."

{% ifversion ghae %}

### Configuring notifications

{% endif %}
You can configure notifications for a repository on the repository page, or on your watching page.

### About custom notifications

You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository. For more information, see "[Configuring your watch settings for an individual repository](#configuring-your-watch-settings-for-an-individual-repository)" below.

### Participating in conversations

Anytime you comment in a conversation or when someone @mentions your username, you are participating in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox.

{% ifversion update-notification-settings-22 %}For conversations you're watching or participating in, you can choose whether you want to receive notifications on {% data variables.product.company_short %} or by email in your notification settings. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)."
Expand Down Expand Up @@ -229,6 +233,7 @@ For more information about the notification delivery methods available to you, a
For more information on how to configure notifications for {% data variables.secret-scanning.alerts %}, see "[Configuring notifications for secret scanning alerts](/code-security/secret-scanning/managing-alerts-from-secret-scanning#configuring-notifications-for-secret-scanning-alerts)."

{% ifversion update-notification-settings-22 or ghes %}

## {% data variables.product.prodname_actions %} notification options

For repositories that are set up with {% data variables.product.prodname_actions %} and that you are watching, you can choose how you want to receive workflow run updates.
Expand All @@ -254,6 +259,7 @@ On the "Notification settings" page, select "Email" or "Web" notifications. Opti
If you're an organization owner, you'll receive email notifications by default when organization members add new deploy keys to repositories within the organization. You can unsubscribe from these notifications. On the notification settings page, under "Organization alerts", unselect **Email**.

{% ifversion fpt or ghes or ghec %}

## Managing your notification settings with {% data variables.product.prodname_mobile %}

When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ To filter notifications by why you've received an update, you can use the `reaso
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.

{% ifversion fpt or ghec %}

### Supported `author:` queries

To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (issue, pull request, gist, discussions, and so on) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ If you select the "Busy" option, when people @mention your username, assign you
7. Click **Set status**.

{% ifversion fpt or ghec %}

## Displaying badges on your profile

When you participate in certain programs, {% data variables.product.prodname_dotcom %} automatically displays a badge on your profile.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ An appointed successor can manage your public repositories after presenting a de
To request access to manage repositories as a successor, contact [GitHub Support](https://support.github.com/contact?tags=docs-accounts).

## Inviting a successor

The person you invite to be your successor must have a {% data variables.product.company_short %} account.

{% data reusables.user-settings.access_settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_RE
Your user name is what immediately follows the `https://{% data variables.command_line.backticks %}/`.

{% ifversion fpt or ghec %}

## Further reading

- "[AUTOTITLE](/get-started/signing-up-for-github/verifying-your-email-address)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ You'll see updates in your news feed when a user you follow:
For more information about following people and watching repositories, see "[AUTOTITLE](/get-started/exploring-projects-on-github/following-people)" and "[AUTOTITLE](/get-started/quickstart/be-social)."

{% ifversion for-you-feed %}

### For you feed

{% note %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ You can set scheduled reminders for personal or team-level review requests for p
{% data reusables.reminders.test-reminder %}

## Managing scheduled reminders for your personal account

{% data reusables.user-settings.access_settings %}
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to edit scheduled reminders for, click {% octicon "pencil" aria-label="Edit reminder" %}.
Expand All @@ -51,6 +52,7 @@ You can set scheduled reminders for personal or team-level review requests for p
{% data reusables.reminders.test-reminder %}

## Deleting scheduled reminders for your personal account

{% data reusables.user-settings.access_settings %}
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to delete reminders for, click {% octicon "pencil" aria-label="Edit reminder" %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ If your organization uses {% data variables.product.prodname_ghe_cloud %}, you c
{% endif %}

{% ifversion enterprise-owners-visible-for-org-members %}

## View enterprise owners and their roles in an organization

If your organization is managed by an enterprise account, then you can view the enterprise owners who manage billing settings and policies for all of your enterprise's organizations. For more information about enterprise accounts, see "[AUTOTITLE](/get-started/learning-about-github/types-of-github-accounts)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ shortTitle: User into an organization
{% endwarning %}

{% ifversion fpt or ghec or ghes %}

## Keep your personal account and create a new organization manually

If you want your organization to have the same name that you are currently using for your personal account, or if you want to keep your personal account's information intact, then you must create a new organization and transfer your repositories to it instead of converting your personal account into an organization.
Expand Down Expand Up @@ -62,6 +63,7 @@ When you convert a personal account into an organization, we'll add collaborator
1. Sign in to the new personal account you created earlier, then use the context switcher to access your new organization.

## Further reading

- "[AUTOTITLE](/organizations/organizing-members-into-teams)"
{% ifversion fpt or ghec %}
- "[AUTOTITLE](/organizations/managing-membership-in-your-organization/inviting-users-to-join-your-organization)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ This procedure demonstrates how to create the service account for your GKE integ
Store the name of your project as a secret named `GKE_PROJECT`. For more information about how to store a secret, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)."

### (Optional) Configuring kustomize

Kustomize is an optional tool used for managing YAML specs. After creating a `kustomization` file, the workflow below can be used to dynamically set fields of the image and pipe in the result to `kubectl`. For more information, see [kustomize usage](https://github.com/kubernetes-sigs/kustomize#usage).

### (Optional) Configure a deployment environment
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Deployments to an environment can be approved or rejected based on the condition
Alternatively, you can write your own protection rules for any of the above use cases or you can define any custom logic to safely approve or reject deployments from pre-production to production environments.

## Creating a custom deployment protection rule with {% data variables.product.prodname_github_apps %}

1. Create a {% data variables.product.prodname_github_app %}. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/creating-a-github-app)." Configure the {% data variables.product.prodname_github_app %} as follows.
1. Optionally, in the **Callback URL** text field under "Identifying and authorizing users," enter the callback URL. For more information, see "[AUTOTITLE](/apps/creating-github-apps/creating-github-apps/about-the-user-authorization-callback-url)."
1. Under "Permissions," select **Repository permissions**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ curl -H "Authorization: bearer $ACTIONS_ID_TOKEN_REQUEST_TOKEN" "$ACTIONS_ID_TOK
{% data reusables.actions.oidc-permissions-token %}

{% ifversion actions-oidc-hardening-config %}

## Customizing the token claims

You can security harden your OIDC configuration by customizing the claims that are included with the JWT. These customisations allow you to define more granular trust conditions on your cloud roles when allowing your workflows to access resources hosted in the cloud:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@ Use deployment branches to restrict which branches can deploy to the environment
{% endnote %}{% endif %}

{% ifversion actions-break-glass %}

### Allow administrators to bypass configured protection rules

By default, administrators can bypass the protection rules and force deployments to specific environments. For more information, see "[AUTOTITLE](/actions/managing-workflow-runs/reviewing-deployments#bypassing-environment-protection-rules)."
Expand Down Expand Up @@ -138,6 +139,7 @@ Secrets stored in an environment are only available to workflow jobs that refere
{% endif %}

{% ifversion actions-configuration-variables %}

## Environment variables

Variables stored in an environment are only available to workflow jobs that reference the environment. These variables are only accessible using the [`vars`](/actions/learn-github-actions/contexts#vars-context) context. For more information, see "[AUTOTITLE](/actions/learn-github-actions/variables)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ The script tests each service, and outputs either a `PASS` or `FAIL` for each on
If you have any failing checks, you should also verify that your self-hosted runner machine meets all the communication requirements. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners#communication-requirements)."

### Disabling TLS certificate verification

{% ifversion ghes %}
By default, the self-hosted runner application verifies the TLS certificate for {% data variables.product.product_name %}. If your {% data variables.product.product_name %} has a self-signed or internally-issued certificate, you may wish to disable TLS certificate verification for testing purposes.
{% else %}
Expand Down Expand Up @@ -269,6 +270,7 @@ User=runner-user
{% endlinux %}

{% ifversion ghes %}

## Resolving runners that are offline after an upgrade of {% data variables.location.product_location %}

{% data reusables.actions.upgrade-runners-before-upgrade-ghes %}
Expand Down
1 change: 1 addition & 0 deletions content/actions/learn-github-actions/contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -878,6 +878,7 @@ jobs:
{% endraw %}

{% ifversion actions-unified-inputs %}

### Example usage of the `inputs` context in a manually triggered workflow

This example workflow triggered by a `workflow_dispatch` event uses the `inputs` context to get the values of the `build_id`, `deploy_target`, and `perform_deploy` inputs that were passed to the workflow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ For more information, see "[AUTOTITLE](/actions/creating-actions)."
{% data reusables.actions.contacting-support %}

{% ifversion ghec or ghes or ghae %}

## Further reading

- "[AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,14 @@ Usage limits apply to self-hosted runners. For more information, see "[AUTOTITLE
{% endif %}

{% ifversion fpt or ghec %}

## Usage policy

In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/free-pro-team@latest/site-policy/github-terms/github-terms-of-service). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/free-pro-team@latest/site-policy/github-terms/github-terms-for-additional-products-and-features#a-actions-usage).
{% endif %}

{% ifversion fpt or ghes or ghec %}

## Billing for reusable workflows

{% data reusables.actions.reusable-workflows-enterprise-beta %}
Expand Down
1 change: 1 addition & 0 deletions content/actions/learn-github-actions/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ The following rules apply to configuration variable names:
1. Click **Add variable**.

### Limits for configuration variables

{% ifversion ghes %}
{% ifversion ghes > 3.8 %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ gh run watch
{% endcli %}

{% ifversion re-run-jobs %}

## Re-running failed jobs in a workflow

If any jobs in a workflow run failed, you can re-run just the jobs that failed. When you re-run failed jobs in a workflow, a new workflow run will start for all failed jobs and their dependents. Any outputs for any successful jobs in the previous workflow run will be used for the re-run. Any artifacts that were created in the initial run will be available in the re-run. Any environment protection rules that passed in the previous run will automatically pass in the re-run.
Expand Down Expand Up @@ -147,6 +148,7 @@ gh run rerun --job JOB_ID --debug
{% endif %}

{% ifversion fpt or ghes > 3.4 or ghae or ghec %}

## Reviewing previous workflow runs

You can view the results from your previous attempts at running a workflow. You can also view previous workflow runs using the API. For more information, see "[AUTOTITLE](/rest/actions#get-a-workflow-run)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ For more information about environments and required approvals, see "[AUTOTITLE]
- To reject the job, click **Reject**. If a job is rejected, the workflow will fail.

{% ifversion actions-break-glass %}

## Bypassing environment protection rules

If you have configured environment protection rules that control whether software can be deployed to an environment, you can bypass these rules and force all pending jobs referencing the environment to proceed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ shortTitle: About monitoring and troubleshooting
## Monitoring your workflows

{% ifversion github-runner-dashboard %}

### Monitoring your current jobs in your organization or enterprise

{% data reusables.actions.github-hosted-runners-check-concurrency %}
Expand All @@ -35,6 +36,7 @@ For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-w
For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge)."

{% ifversion fpt or ghec %}

### Viewing job execution time

To identify how long a job took to run, you can view its execution time. For more information, see "[AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/viewing-job-execution-time)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ PR title did not start with 'octocat'
With this approach, the value of the {% raw %}`${{ github.event.issue.title }}`{% endraw %} expression is stored in memory and used as a variable, and doesn't interact with the script generation process. In addition, consider using double quote shell variables to avoid [word splitting](https://github.com/koalaman/shellcheck/wiki/SC2086), but this is [one of many](https://mywiki.wooledge.org/BashPitfalls) general recommendations for writing shell scripts, and is not specific to {% data variables.product.prodname_actions %}.

{% ifversion fpt or ghec %}

### Using starter workflows for code scanning

{% data reusables.advanced-security.starter-workflows-beta %}
Expand Down Expand Up @@ -205,12 +206,14 @@ You can help mitigate this risk by following these good practices:
The same principles described above for using third-party actions also apply to using third-party workflows. You can help mitigate the risks associated with reusing workflows by following the same good practices outlined above. For more information, see "[AUTOTITLE](/actions/using-workflows/reusing-workflows)."

{% ifversion not ghae %}

## Using {% data variables.product.prodname_dependabot_version_updates %} to keep actions up to date

You can use {% data variables.product.prodname_dependabot_version_updates %} to ensure that references to actions{% ifversion dependabot-updates-actions-reusable-workflows %} and reusable workflows{% endif %} used in your repository are kept up to date. Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. {% data variables.product.prodname_dependabot_version_updates %} take the effort out of maintaining your dependencies as {% data variables.product.prodname_dependabot %} does this automatically for you. For more information, see "[AUTOTITLE](/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot)."
{% endif %}

{% ifversion internal-actions %}

## Allowing workflows to access internal {% ifversion private-actions %}and private {% endif %}repositories

{% data reusables.actions.outside-collaborators-actions %} For more information, see "[AUTOTITLE](/actions/creating-actions/sharing-actions-and-workflows-with-your-enterprise)."
Expand All @@ -220,6 +223,7 @@ You can use {% data variables.product.prodname_dependabot_version_updates %} to
{% endif %}

{% ifversion allow-actions-to-approve-pr %}

## Preventing {% data variables.product.prodname_actions %} from {% ifversion allow-actions-to-approve-pr-with-ent-repo %}creating or {% endif %}approving pull requests

{% data reusables.actions.workflow-pr-approval-permissions-intro %} Allowing workflows, or any other automation, to {% ifversion allow-actions-to-approve-pr-with-ent-repo %}create or {% endif %}approve pull requests could be a security risk if the pull request is merged without proper oversight.
Expand Down Expand Up @@ -362,6 +366,7 @@ A self-hosted runner can be added to various levels in your {% data variables.pr
- You could also add runners at the repository level, but this will add management overhead and also increases the numbers of runners you need, since you cannot share runners between repositories.

{% ifversion fpt or ghec or ghes > 3.4 %}

### Authenticating to your cloud provider

If you are using {% data variables.product.prodname_actions %} to deploy to a cloud provider, or intend to use HashiCorp Vault for secret management, then its recommended that you consider using OpenID Connect to create short-lived, well-scoped access tokens for your workflow runs. For more information, see "[AUTOTITLE](/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,7 @@ Actions that run in Docker containers have static directories under the `/github
- `/github/workflow`

## Further reading

- "[AUTOTITLE](/billing/managing-billing-for-github-actions)"
- You can use a matrix strategy to run your jobs on multiple images. For more information, see "[AUTOTITLE](/actions/using-jobs/using-a-matrix-for-your-jobs)."

Expand Down
Loading