Skip to content

Commit 50f6b59

Browse files
authored
Merge branch 'main' into demographic
2 parents c06531b + d3cd9b7 commit 50f6b59

File tree

33 files changed

+416
-425
lines changed

33 files changed

+416
-425
lines changed
67.3 KB
Loading
150 KB
Loading
118 KB
Loading

content/actions/concepts/workflows-and-actions/notifications-for-workflow-runs.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@ redirect_from:
1010
- /actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/notifications-for-workflow-runs
1111
---
1212

13-
{% data reusables.actions.enterprise-github-hosted-runners %}
13+
If you enable email or web notifications for {% data variables.product.prodname_actions %}, you'll receive a notification when any workflow runs that you've triggered have completed. The notification will include the workflow run's status (including successful, failed, neutral, and canceled runs). You can also choose to receive a notification only when a workflow run has failed. For more information about enabling or disabling notifications, see [AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications).
1414

15-
{% data reusables.repositories.workflow-notifications %}
15+
Notifications for scheduled workflows are sent to the user who initially created the workflow.
16+
* If a different user updates the cron syntax, in the `schedule` event in the workflow file, subsequent notifications will be sent to that user instead.
17+
* If a scheduled workflow is disabled and then re-enabled, notifications will be sent to the user who re-enabled the workflow rather than the user who last modified the cron syntax.
18+
19+
You can also see the status of workflow runs on a repository's Actions tab. For more information, see [AUTOTITLE](/actions/managing-workflow-runs).

content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md

Lines changed: 22 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -966,58 +966,44 @@ jobs:
966966

967967
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
968968
| --------------------- | -------------- | ------------ | -------------|
969-
| Not applicable | Not applicable | Last commit on default branch | Default branch | When the scheduled workflow is set to run. A scheduled workflow uses [POSIX cron syntax](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07). For more information, see [AUTOTITLE](/actions/using-workflows#triggering-a-workflow-with-events). |
969+
| Not applicable | Not applicable | Last commit on default branch | Default branch |
970970

971971
> [!NOTE]
972972
> * {% data reusables.actions.schedule-delay %}
973-
> * This event will only trigger a workflow run if the workflow file is on the default branch.
973+
> * {% data reusables.actions.branch-requirement %}
974974
> * Scheduled workflows will only run on the default branch.
975975
> * In a public repository, scheduled workflows are automatically disabled when no repository activity has occurred in 60 days. For information on re-enabling a disabled workflow, see [AUTOTITLE](/enterprise-server/actions/using-workflows/disabling-and-enabling-a-workflow#enabling-a-workflow).
976-
> * For an enterprise with {% data variables.product.prodname_emus %}, scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned (and therefore become suspended) by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`. Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running. Essentially, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted). Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located.
977-
> * Certain repository events change the `actor` associated with the workflow. For example, a user who changes the default branch of the repository, which changes the branch on which scheduled workflows run, becomes `actor` for those scheduled workflows.
978-
> * For a deactivated scheduled workflow, if a user with `write` permissions to the repository makes a commit that changes the `cron` schedule on the workflow, the workflow will be reactivated, and that user will become the `actor` associated with any workflow runs. Note that, in this situation, the workflow is not reactivated by any change to the workflow file; you must alter the `cron` value in the workflow and commit this change.
979-
>
980-
> **Example:**
981-
>
982-
> ```yaml
983-
> on:
984-
> schedule:
985-
> - cron: "15 4,5 * * *" # <=== Change this value
986-
> ```
987976

988977
The `schedule` event allows you to trigger a workflow at a scheduled time.
989978

990-
{% data reusables.repositories.actions-scheduled-workflow-example %}
991-
992-
Cron syntax has five fields separated by a space, and each field represents a unit of time.
993-
994-
```text
995-
┌───────────── minute (0 - 59)
996-
│ ┌───────────── hour (0 - 23)
997-
│ │ ┌───────────── day of the month (1 - 31)
998-
│ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
999-
│ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
1000-
│ │ │ │ │
1001-
│ │ │ │ │
1002-
│ │ │ │ │
1003-
* * * * *
1004-
```
979+
**Example:**
1005980

1006-
You can use these operators in any of the five fields:
981+
```yaml
982+
on:
983+
schedule:
984+
- cron: "15 4,5 * * *"
985+
```
1007986

1008-
| Operator | Description | Example |
1009-
| -------- | ----------- | ------- |
1010-
| * | Any value | `15 * * * *` runs at every minute 15 of every hour of every day. |
1011-
| , | Value list separator | `2,10 4,5 * * *` runs at minute 2 and 10 of the 4th and 5th hour of every day. |
1012-
| - | Range of values | `30 4-6 * * *` runs at minute 30 of the 4th, 5th, and 6th hour. |
1013-
| / | Step values | `20/15 * * * *` runs every 15 minutes starting from minute 20 through 59 (minutes 20, 35, and 50). |
987+
{% data reusables.repositories.actions-scheduled-workflow-example %}
1014988

1015989
> [!NOTE]
1016990
> {% data variables.product.prodname_actions %} does not support the non-standard syntax `@yearly`, `@monthly`, `@weekly`, `@daily`, `@hourly`, and `@reboot`.
1017991

1018992
You can use [crontab guru](https://crontab.guru/) to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of [crontab guru examples](https://crontab.guru/examples.html).
1019993

1020-
Notifications for scheduled workflows are sent to the user who last modified the cron syntax in the workflow file. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs).
994+
### `actor` for scheduled workflows
995+
996+
Certain repository events change the `actor` associated with the workflow. For example, a user who changes the default branch of the repository, which changes the branch on which scheduled workflows run, becomes `actor` for those scheduled workflows.
997+
998+
For a deactivated scheduled workflow, if a user with `write` permissions to the repository makes a commit that changes the `cron` schedule on the workflow, the workflow will be reactivated, and that user will become the `actor` associated with any workflow runs.
999+
1000+
Notifications for scheduled workflows are sent to the user who last modified the cron syntax in the workflow file. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/notifications-for-workflow-runs).
1001+
1002+
> [!NOTE]
1003+
> For an enterprise with {% data variables.product.prodname_emus %}, triggering a scheduled workflow requires that the status of the `actor` user account associated with the workflow is currently active (i.e. not suspended or deleted).
1004+
> * Scheduled workflows will not run if the last `actor` associated with the scheduled workflow has been deprovisioned by the {% data variables.product.prodname_emu %} identity provider (IdP). However, if the last `actor` {% data variables.product.prodname_emu %} has not been deprovisioned by the IdP, and has only been removed as a member from a given organization in the enterprise, scheduled workflows will still run with that user set as the `actor`.
1005+
> * Similarly, for an enterprise without {% data variables.product.prodname_emus %}, removing a user from an organization will not prevent scheduled workflows which had that user as their `actor` from running.
1006+
> * Thus, the _user account's_ status, in both {% data variables.product.prodname_emu %} and non-{% data variables.product.prodname_emu %} scenarios, is what's important, _not_ the user's _membership status_ in the organization where the scheduled workflow is located.
10211007

10221008
## `status`
10231009

content/actions/reference/workflows-and-actions/workflow-syntax.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,11 @@ run-name: Deploy to ${{ inputs.deploy_target }} by @${{ github.actor }}
107107

108108
## `on.schedule`
109109

110-
{% data reusables.actions.workflows.section-triggering-a-workflow-schedule %}
110+
You can use `on.schedule` to define a time schedule for your workflows.
111+
112+
{% data reusables.repositories.actions-scheduled-workflow-example %}
113+
114+
For more information about `schedule` events, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#schedule).
111115

112116
## `on.workflow_call`
113117

content/actions/tutorials/migrate-to-github-actions/manual-migrations/migrate-from-jenkins.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,8 @@ on:
126126
- cron: '*/15 * * * 1-5'
127127
```
128128
129+
For more information about `schedule` events and accepted cron syntax, see [AUTOTITLE](/actions/reference/workflows-and-actions/events-that-trigger-workflows#schedule).
130+
129131
### Configuring environment variables in a pipeline
130132

131133
#### Jenkins pipeline with an environment variable

content/actions/tutorials/use-actions-runner-controller/deploy-runner-scale-sets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ ARC supports using anonymous or authenticated proxies. If you use authenticated
249249
The `maxRunners` and `minRunners` properties provide you with a range of options to customize your ARC setup.
250250

251251
> [!NOTE]
252-
> ARC does not support scheduled maximum and minimum configurations. You can use a cronjob or any other scheduling solution to update the configuration on a schedule.
252+
> ARC does not support scheduled maximum and minimum configurations. You can use a cron job or any other scheduling solution to update the configuration on a schedule.
253253

254254
#### Example: Unbounded number of runners
255255

content/admin/configuring-settings/hardening-security-for-your-enterprise/restricting-access-to-githubcom-using-a-corporate-proxy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Because this restriction only applies to requests that are sent via a proxy that
7676
| {% data variables.product.prodname_pages %} | `github.io` | This is generally user-generated content that cannot accept data. You may not want to restrict access. |
7777
| {% data variables.product.prodname_github_codespaces %} | `github.dev` | To restrict access, block the endpoint entirely. |
7878
| SSH access | Port 22 on {% data variables.product.prodname_dotcom_the_website %} | To restrict access, block the endpoint entirely. |
79+
| SSH over HTTPS | `ssh.github.com` | To restrict access, block the endpoint entirely. |
7980
| {% data variables.product.github %}-hosted runners | Various | To enforce specific routing, use Azure private networking. See [AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise). |
8081

8182
### Endpoints that don't require restriction

content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -316,6 +316,8 @@ To restart streaming, click **Resume stream**.
316316

317317
## Enabling audit log streaming of API requests
318318

319+
>[!NOTE] Not all API requests are included in the audit log stream after this feature is enabled. The streaming of API requests is limited to security relevant endpoints.
320+
319321
{% data reusables.enterprise-accounts.access-enterprise %}
320322
{% data reusables.enterprise-accounts.settings-tab %}
321323
{% data reusables.enterprise-accounts.audit-log-tab %}

0 commit comments

Comments
 (0)