Skip to content

Commit 309b925

Browse files
authored
Merge branch 'main' into patch-2
2 parents 1e2414b + f7676a0 commit 309b925

46 files changed

Lines changed: 473 additions & 141 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/allowed-actions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ module.exports = [
3131
'rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9',
3232
'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',
3333
'repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88',
34-
'repo-sync/pull-request@ea6773388b83b337e4da9a223293309f2c3670e7',
34+
'repo-sync/pull-request@58af525d19d3c2b4f744d3348c6823b6340a4921',
3535
'rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815',
3636
'tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0'
3737
]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Repo Freeze Reminders
2+
3+
on:
4+
schedule:
5+
- cron: "00 11 * * *" # once per day around 11:00am UTC
6+
7+
env:
8+
FREEZE: ${{ secrets.FREEZE }}
9+
10+
jobs:
11+
check-freezer:
12+
name: Remind about deployment freezes
13+
runs-on: ubuntu-latest
14+
steps:
15+
16+
- name: Send Slack notification if repo is frozen
17+
if: ${{ env.FREEZE == 'true' }}
18+
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
19+
env:
20+
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
21+
SLACK_USERNAME: docs-repo-sync
22+
SLACK_ICON_EMOJI: ':freezing_face:'
23+
SLACK_COLOR: '#51A0D5' # Carolina Blue
24+
SLACK_MESSAGE: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen!

.github/workflows/repo-sync.yml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ env:
1414
FREEZE: ${{ secrets.FREEZE }}
1515

1616
jobs:
17-
repo-sync:
18-
name: Repo Sync
17+
check-freezer:
18+
name: Check for deployment freezes
1919
runs-on: ubuntu-latest
2020
steps:
2121

@@ -25,6 +25,12 @@ jobs:
2525
echo 'The repo is currently frozen! Exiting this workflow.'
2626
exit 1 # prevents further steps from running
2727
28+
repo-sync:
29+
name: Repo Sync
30+
needs: check-freezer
31+
runs-on: ubuntu-latest
32+
steps:
33+
2834
- name: Check out repo
2935
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
3036

@@ -39,7 +45,7 @@ jobs:
3945
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
4046

4147
- name: Create pull request
42-
uses: repo-sync/pull-request@ea6773388b83b337e4da9a223293309f2c3670e7
48+
uses: repo-sync/pull-request@58af525d19d3c2b4f744d3348c6823b6340a4921
4349
env:
4450
GITHUB_TOKEN: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
4551
with:
@@ -56,6 +62,7 @@ jobs:
5662
with:
5763
github-token: ${{ secrets.GITHUB_TOKEN }}
5864
branch: repo-sync
65+
base: main
5966

6067
- name: Approve pull request
6168
if: ${{ steps.find-pull-request.outputs.number }}
@@ -66,7 +73,10 @@ jobs:
6673

6774
- name: Send Slack notification if workflow fails
6875
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
69-
if: failure()
76+
if: ${{ failure() }}
7077
env:
7178
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
79+
SLACK_USERNAME: docs-repo-sync
80+
SLACK_ICON_EMOJI: ':ohno:'
81+
SLACK_COLOR: '#B90E0A' # Crimson
7282
SLACK_MESSAGE: The last repo-sync run for ${{github.repository}} failed. See https://github.com/${{github.repository}}/actions?query=workflow%3A%22Repo+Sync%22
179 KB
Loading

content/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,4 +237,4 @@ Sometimes you want to link to a Dotcom-only article in Enterprise content and yo
237237
<a href="/github/site-policy/github-terms-of-service" class="dotcom-only">GitHub's Terms of Service</a>
238238
```
239239

240-
Sometimes the canonical home of content moves outside the docs site. None of the links included in [`lib/redirects/external-redirects.json`](lib/redirects/external-redirects.json) get rewritten. See [`contributing/redirects.md`](contributing/redirects.md) for more info about this type of redirect.
240+
Sometimes the canonical home of content moves outside the docs site. None of the links included in [`lib/redirects/external-sites.json`](/lib/redirects/external-sites.json) get rewritten. See [`contributing/redirects.md`](/contributing/redirects.md) for more info about this type of redirect.

content/actions/learn-github-actions/security-hardening-for-github-actions.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,42 @@ As a result, self-hosted runners should almost [never be used for public reposit
9595
You should also consider the environment of the self-hosted runner machines:
9696
- What sensitive information resides on the machine configured as a self-hosted runner? For example, private SSH keys, API access tokens, among others.
9797
- Does the machine have network access to sensitive services? For example, Azure or AWS metadata services. The amount of sensitive information in this environment should be kept to a minimum, and you should always be mindful that any user capable of invoking workflows has access to this environment.
98+
99+
### Auditing {% data variables.product.prodname_actions %} events
100+
101+
You can use the audit log to monitor administrative tasks in an organization. The audit log records the type of action, when it was run, and which user account perfomed the action.
102+
103+
For example, you can use the audit log to track the `action:org.update_actions_secret` event, which tracks changes to organization secrets:
104+
![Audit log entries](/assets/images/help/repository/audit-log-entries.png)
105+
106+
The following tables describe the {% data variables.product.prodname_actions %} events that you can find in the audit log. For more information on using the audit log, see
107+
"[Reviewing the audit log for your organization](/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)."
108+
109+
#### Events for secret management
110+
| Action | Description
111+
|------------------|-------------------
112+
| `action:org.create_actions_secret` | Triggered when a organization admin [creates a {% data variables.product.prodname_actions %} secret](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-an-organization).
113+
| `action:org.remove_actions_secret` | Triggered when a organization admin removes a {% data variables.product.prodname_actions %} secret.
114+
| `action:org.update_actions_secret` | Triggered when a organization admin updates a {% data variables.product.prodname_actions %} secret.
115+
| `action:repo.create_actions_secret ` | Triggered when a repository admin [creates a {% data variables.product.prodname_actions %} secret](/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository).
116+
| `action:repo.remove_actions_secret` | Triggered when a repository admin removes a {% data variables.product.prodname_actions %} secret.
117+
| `action:repo.update_actions_secret` | Triggered when a repository admin updates a {% data variables.product.prodname_actions %} secret.
118+
119+
#### Events for self-hosted runners
120+
| Action | Description
121+
|------------------|-------------------
122+
| `action:org.register_self_hosted_runner` | Triggered when an organization owner [registers a new self-hosted runner](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-an-organization).
123+
| `action:org.remove_self_hosted_runner` | Triggered when an organization owner [removes a self-hosted runner](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-an-organization).
124+
| `action:repo.register_self_hosted_runner` | Triggered when a repository admin [registers a new self-hosted runner](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository).
125+
| `action:repo.remove_self_hosted_runner` | Triggered when a repository admin [removes a self-hosted runner](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository).
126+
127+
#### Events for self-hosted runner groups
128+
| Action | Description
129+
|------------------|-------------------
130+
| `action:org.runner_group_created` | Triggered when an organization admin [creates a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#creating-a-self-hosted-runner-group-for-an-organization).
131+
| `action:org.runner_group_removed` | Triggered when an organization admin removes a self-hosted runner group.
132+
| `action:org.runner_group_renamed` | Triggered when an organization admin renames a self-hosted runner group.
133+
| `action:org.runner_group_runners_added` | Triggered when an organization admin [adds a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group).
134+
| `action:org.runner_group_runners_removed` | Triggered when an organization admin removes a self-hosted runner from a group.
135+
136+

content/admin/configuration/enabling-alerts-for-vulnerable-dependencies-on-github-enterprise-server.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,13 @@ You can connect {% data variables.product.product_location_enterprise %} to {% d
1818

1919
After connecting {% data variables.product.product_location_enterprise %} to {% data variables.product.prodname_dotcom_the_website %} and enabling {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_short %}{% else %}security{% endif %} alerts for vulnerable dependencies, vulnerability data is synced from {% data variables.product.prodname_dotcom_the_website %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location_enterprise %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}.
2020

21-
{% if currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.product_location_enterprise %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and send {% data variables.product.prodname_dependabot_short %} alerts to owners and people with admin access in those repositories. They can customize how they receive {% data variables.product.prodname_dependabot_short %} alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/#configuring-notifications-for-github-dependabot-alerts)."
21+
{% if currentVersion ver_gt "enterprise-server@2.21" %}When {% data variables.product.product_location_enterprise %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and send {% data variables.product.prodname_dependabot_short %} alerts. You can customize how you receive {% data variables.product.prodname_dependabot_short %} alerts. For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies/#configuring-notifications-for-github-dependabot-alerts)."
2222
{% endif %}
2323

24-
{% if currentVersion ver_lt "enterprise-server@2.21" or currentVersion == "enterprise-server@2.21" %}When {% data variables.product.product_location_enterprise %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and send security alerts to owners and people with admin access in those repositories. They can customize how they receive security alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/#configuring-notifications-for-security-alerts)."
24+
{% if currentVersion == "enterprise-server@2.21" %}When {% data variables.product.product_location_enterprise %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and send security alerts. You can customize how you receive security alerts. For more information, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies/#configuring-notifications-for-security-alerts)."
25+
{% endif %}
26+
27+
{% if currentVersion ver_lt "enterprise-server@2.21" %}When {% data variables.product.product_location_enterprise %} receives information about a vulnerability, it will identify repositories in your instance that use the affected version of the dependency and send security alerts. You can customize how you receive security alerts. For more information, see "[Choosing the delivery method for your notifications](/github/receiving-notifications-about-activity-on-github/choosing-the-delivery-method-for-your-notifications#choosing-the-delivery-method-for-security-alerts-for-vulnerable-dependencies)."
2528
{% endif %}
2629

2730
{% if currentVersion ver_gt "enterprise-server@2.21" %}

content/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,15 @@ The time required to failover depends on how long it takes to manually promote t
3030
5. Update the DNS record to point to the IP address of the replica. Traffic is directed to the replica after the TTL period elapses. If you are using a load balancer, ensure it is configured to send traffic to the replica.
3131
6. Notify users that they can resume normal operations.
3232
7. If desired, set up replication from the new primary to existing appliances and the previous primary. For more information, see "[About high availability configuration](/enterprise/{{ currentVersion }}/admin/guides/installation/about-high-availability-configuration/#utilities-for-replication-management)."
33+
8. Appliances you do not intend to setup replication to that were part of the high availability configuration prior the failover, need to be removed from the high availability configuration by UUID.
34+
- On the former appliances, get their UUID via `cat /data/user/common/uuid`.
35+
```shell
36+
$ cat /data/user/common/uuid
37+
```
38+
- On the new primary, remove the UUIDs using `ghe-repl-teardown`. Please replace *`UUID`* with a UUID you retrieved in the previous step.
39+
```shell
40+
$ ghe-repl-teardown -u <em>UUNID</em>
41+
```
3342

3443
### Further reading
3544

content/admin/github-actions/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ You can populate the runner tool cache by running a {% data variables.product.pr
3434

3535
### Populating the tool cache for a self-hosted runner
3636

37-
1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repostory that you can use to run a {% data variables.product.prodname_actions %} workflow.
37+
1. On {% data variables.product.prodname_dotcom_the_website %}, navigate to a repository that you can use to run a {% data variables.product.prodname_actions %} workflow.
3838
1. Create a new workflow file in the repository's `.github/workflows` folder that uploads an artifact containing the {% data variables.product.prodname_dotcom %}-hosted runner's tool cache.
3939

4040
The following example demonstrates a workflow that uploads the tool cache for an Ubuntu 18.04 environment, using the `setup-node` action with Node.js versions 10 and 12.

content/developers/webhooks-and-events/github-event-types.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ The event objects returned from the Events API endpoints have the same structure
2828
| `actor.id` | The unique identifier for the actor. |
2929
| `actor.login` | The username of the actor. |
3030
| `actor.display_login` | The specific display format of the username. |
31-
| `actor.gravatar_id` | The unique indentifier of the Gravatar profile for the actor. |
31+
| `actor.gravatar_id` | The unique identifier of the Gravatar profile for the actor. |
3232
| `actor.url` | The REST API URL used to retrieve the user object, which includes additional user information. |
3333
| `actor.avatar_url` | The URL of the actor's profile image. |
3434
| `repo` | The repository object where the event occurred. |
3535
| `repo.id` | The unique identifier of the repository. |
3636
| `repo.name` | The name of the repository, which includes the owner and repository name. For example, `octocat/hello-world` is the name of the `hello-world` repository owned by the `octocat` user account. |
37-
| `repo.url` | The REST API URL used to retrive the repository object, which includes additional repository information. |
37+
| `repo.url` | The REST API URL used to retrieve the repository object, which includes additional repository information. |
3838
| `payload` | The event payload object is unique to the event type. See the event type below for the event API `payload` object. |
3939

4040
#### Example WatchEvent event object

0 commit comments

Comments
 (0)