Skip to content

Commit

Permalink
Merge pull request github#29335 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Oct 23, 2023
2 parents 67869d7 + 561f8fb commit e4ee7b1
Show file tree
Hide file tree
Showing 34 changed files with 75 additions and 31 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,20 @@ The custom scripts must be located on the runner, but should not be stored in th

The scripts are automatically executed when the runner has the following environment variables containing an absolute path to the script:
- `ACTIONS_RUNNER_HOOK_JOB_STARTED`: The script defined in this environment variable is triggered when a job has been assigned to a runner, but before the job starts running.
- `ACTIONS_RUNNER_HOOK_JOB_COMPLETED`: The script defined in this environment variable is triggered after the job has finished processing.
- `ACTIONS_RUNNER_HOOK_JOB_COMPLETED`: The script defined in this environment variable is triggered at the end of the job, after all the steps defined in the workflow have run.

To set these environment variables, you can either add them to the operating system, or add them to a file named `.env` within the self-hosted runner application directory (that is, the directory into which you downloaded and unpacked the runner software). For example, the following `.env` entry will have the runner automatically run a script, saved as `/opt/runner/cleanup_script.sh` on the runner machine, before each job runs:

```bash
ACTIONS_RUNNER_HOOK_JOB_STARTED=/opt/runner/cleanup_script.sh
```

{% note %}

**Note**: The script defined in `ACTIONS_RUNNER_HOOK_JOB_COMPLETED` is executed at the end of the job, before the job completes. This makes it unsuitable for use cases that may interrupt a runner, such as deleting the runner machine as part of an autoscaling implementation.

{% endnote %}

## Troubleshooting

### Permission denied
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ After you enable {% data variables.product.prodname_github_connect %}, license d
### Triggering a license sync job

1. Sign in to your {% data variables.product.prodname_ghe_server %} instance.
{% data reusables.enterprise-accounts.access-enterprise %}
{% data reusables.enterprise-accounts.access-enterprise-ghes %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
1. Under "License sync", click {% octicon "sync" aria-hidden="true" %} **Sync now**.
Expand All @@ -49,7 +49,8 @@ After you enable {% data variables.product.prodname_github_connect %}, license d

You can download a JSON file from {% data variables.product.prodname_ghe_server %} and upload the file to {% data variables.product.prodname_ghe_cloud %} to manually sync user license usage between the two deployments.

{% data reusables.enterprise-accounts.access-enterprise %}
1. Sign in to your {% data variables.product.prodname_ghe_server %} instance.
{% data reusables.enterprise-accounts.access-enterprise-ghes %}
{% data reusables.enterprise-accounts.settings-tab %}
{% data reusables.enterprise-accounts.license-tab %}
1. In the "User licenses" section, under "Quick links", to download a file containing your current license usage on {% data variables.product.prodname_ghe_server %}, click **Export license usage**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ topics:

If your project communicates with an external service, you might use a token or private key for authentication. Tokens and private keys are examples of secrets that a service provider can issue. If you check a secret into a repository, anyone who has read access to the repository can use the secret to access the external service with your privileges. We recommend that you store secrets in a dedicated, secure location outside of the repository for your project.

{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for secrets{% ifversion ghec or ghes or ghae %}, even if the repository is archived{% endif %}. {% ifversion secret-scanning-issue-body-comments %}{% data reusables.secret-scanning.scan-issue-description-and-comments %}{% endif %}
{% data variables.product.prodname_secret_scanning_caps %} will scan your entire Git history on all branches present in your {% data variables.product.prodname_dotcom %} repository for secrets{% ifversion ghec or ghes or ghae %}, even if the repository is archived{% endif %}. {% ifversion secret-scanning-issue-body-comments %}{% data reusables.secret-scanning.scan-issue-description-and-comments %}{% else %}{% data variables.product.prodname_secret_scanning_caps %} does not scan issues.{% endif %}

{% ifversion secret-scanning-backfills-historical-issues %}
Additionally, {% data variables.product.prodname_secret_scanning %} scans the titles, descriptions, and comments, in open and closed historical issues, and reports leaked secrets as alerts on {% data variables.product.prodname_dotcom %}{% ifversion ghec %}. A notification is sent to the relevant partner when a historical partner pattern is detected{% endif %}.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ topics:
- Codespaces
- Fundamentals
- Developer
redirect_from:
- /codespaces/developing-in-codespaces/connecting-to-a-private-network
---

## About codespace networking
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ redirect_from:
- /github/developing-online-with-github-codespaces/creating-a-codespace
- /github/developing-online-with-codespaces/creating-a-codespace
- /codespaces/developing-in-codespaces/creating-a-codespace
- /codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository
versions:
fpt: '*'
ghec: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ topics:
- Fundamentals
- Developer
shortTitle: Create a codespace from a template
redirect_from:
- /codespaces/developing-in-codespaces/creating-a-codespace-from-a-template
---

## About templates for {% data variables.product.prodname_github_codespaces %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ topics:
- Codespaces
- Fundamentals
- Developer
redirect_from:
- /codespaces/developing-in-codespaces/default-environment-variables-for-your-codespace
---

## About default environment variables
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: You can delete a codespace you no longer need.
redirect_from:
- /github/developing-online-with-github-codespaces/deleting-a-codespace
- /github/developing-online-with-codespaces/deleting-a-codespace
- /codespaces/developing-in-codespaces/deleting-a-codespace
versions:
fpt: '*'
ghec: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ intro: 'You can work in a codespace using your browser, {% data variables.produc
redirect_from:
- /github/developing-online-with-github-codespaces/developing-in-a-codespace
- /github/developing-online-with-codespaces/developing-in-a-codespace
- /codespaces/developing-in-codespaces/developing-in-a-codespace
versions:
fpt: '*'
ghec: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ versions:
ghec: '*'
redirect_from:
- /github/developing-online-with-codespaces/forwarding-ports-in-your-codespace
- /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace
type: how_to
topics:
- Codespaces
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ type: tutorial
topics:
- Codespaces
- Developer
redirect_from:
- /codespaces/developing-in-codespaces/getting-started-with-github-codespaces-for-machine-learning
---

## Introduction
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,7 @@ children:
- /using-github-codespaces-in-visual-studio-code
- /using-github-codespaces-in-your-jetbrains-ide
- /using-github-codespaces-with-github-cli
redirect_from:
- /codespaces/developing-in-codespaces
---

Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ topics:
- Fundamentals
- Developer
shortTitle: Open an existing codespace
redirect_from:
- /codespaces/developing-in-codespaces/opening-an-existing-codespace
---

{% jetbrains_beta %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ topics:
- Fundamentals
- Developer
shortTitle: Persist variables and files
redirect_from:
- /codespaces/developing-in-codespaces/persisting-environment-variables-and-temporary-files
---

## Setting persistent environment variables
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ topics:
shortTitle: Rebuilding a container
redirect_from:
- /codespaces/codespaces-reference/performing-a-full-rebuild-of-a-container
- /codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace
---

## About rebuilding a container
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ topics:
- Fundamentals
- Developer
shortTitle: Stop a codespace
redirect_from:
- /codespaces/developing-in-codespaces/stopping-and-starting-a-codespace
---

{% jetbrains_beta %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ topics:
- Developer
redirect_from:
- /codespaces/developing-in-codespaces/using-codespaces-for-pull-requests
- /codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests
---

Using a codespace to work on a pull request gives you all the benefits of {% data variables.product.prodname_github_codespaces %}. For more information, see "[AUTOTITLE](/codespaces/overview#benefits-of-github-codespaces)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ redirect_from:
- /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code
- /github/developing-online-with-codespaces/using-codespaces-in-visual-studio
- /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code
- /codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code
versions:
fpt: '*'
ghec: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ type: how_to
topics:
- Codespaces
- Developer
redirect_from:
- /codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide
---

{% data reusables.codespaces.codespaces-jetbrains-beta-note %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ topics:
- Developer
redirect_from:
- /codespaces/developing-in-codespaces/using-codespaces-with-github-cli
- /codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli
---

## About {% data variables.product.prodname_cli %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ topics:
- Fundamentals
- Developer
shortTitle: Source control
redirect_from:
- /codespaces/developing-in-codespaces/using-source-control-in-your-codespace
---

{% jetbrains_beta %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ type: how_to
topics:
- Codespaces
- Developer
redirect_from:
- /codespaces/developing-in-codespaces/working-collaboratively-in-a-codespace
---

{% data variables.product.prodname_vs %} Live Share lets you collaboratively edit and debug with others in real time, within a codespace. You can securely share your current codespace, or access a codespace created by someone else.
Expand Down
26 changes: 13 additions & 13 deletions content/codespaces/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ includeGuides:
- /codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces
- /codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/setting-up-a-template-repository-for-github-codespaces
- /codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account
- /codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository
- /codespaces/developing-in-codespaces/creating-a-codespace-from-a-template
- /codespaces/developing-in-codespaces/developing-in-a-codespace
- /codespaces/developing-in-codespaces/deleting-a-codespace
- /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace
- /codespaces/developing-in-codespaces/opening-an-existing-codespace
- /codespaces/developing-in-codespaces/stopping-and-starting-a-codespace
- /codespaces/developing-in-codespaces/working-collaboratively-in-a-codespace
- /codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code
- /codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide
- /codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli
- /codespaces/developing-in-codespaces/using-source-control-in-your-codespace
- /codespaces/developing-in-codespaces/using-github-codespaces-for-pull-requests
- /codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository
- /codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template
- /codespaces/developing-in-a-codespace/developing-in-a-codespace
- /codespaces/developing-in-a-codespace/deleting-a-codespace
- /codespaces/developing-in-a-codespace/forwarding-ports-in-your-codespace
- /codespaces/developing-in-a-codespace/opening-an-existing-codespace
- /codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace
- /codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace
- /codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code
- /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide
- /codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli
- /codespaces/developing-in-a-codespace/using-source-control-in-your-codespace
- /codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests
- /codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace
- /codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace
- /codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces
Expand Down
12 changes: 6 additions & 6 deletions content/codespaces/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ featuredLinks:
- /billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces
guideCards:
- /codespaces/getting-started/deep-dive
- /codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository
- /codespaces/developing-in-codespaces/creating-a-codespace-from-a-template
- /codespaces/developing-in-codespaces/opening-an-existing-codespace
- /codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository
- /codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template
- /codespaces/developing-in-a-codespace/opening-an-existing-codespace
- /codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account
- /codespaces/developing-in-codespaces/using-github-codespaces-in-visual-studio-code
- /codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide
- /codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code
- /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide
popular:
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-nodejs-project-for-codespaces
- /codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/setting-up-your-python-project-for-codespaces
Expand All @@ -44,7 +44,7 @@ versions:
children:
- /overview
- /getting-started
- /developing-in-codespaces
- /developing-in-a-codespace
- /customizing-your-codespace
- /setting-up-your-project-for-codespaces
- /prebuilding-your-codespaces
Expand Down
3 changes: 2 additions & 1 deletion content/github-cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ featuredLinks:
- /github-cli/github-cli/creating-github-cli-extensions
- /github-cli/github-cli/using-github-cli-extensions
- /actions/using-workflows/using-github-cli-in-workflows
- /codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli
- /codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli
popular:
- /pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
- /issues/tracking-your-work-with-issues/creating-an-issue
Expand All @@ -34,3 +34,4 @@ changelog:
layout: product-landing
beta_product: false
---

2 changes: 2 additions & 0 deletions content/rest/teams/external-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ autogenerated: rest

## About external groups

{% data reusables.scim.ghes-beta-note %}

To use these endpoints, the authenticated user must be a team maintainer or an owner of the organization associated with the team.

{% ifversion ghec %}
Expand Down
1 change: 1 addition & 0 deletions data/features/create-new-repos-with-query-params.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
versions:
fpt: '*'
ghec: '*'
ghes: '>= 3.11'
2 changes: 1 addition & 1 deletion data/features/dependabot-updates-failure-skip-schedule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
versions:
fpt: '*'
ghec: '*'
ghes: '>3.9'
ghes: '>= 3.11'
2 changes: 1 addition & 1 deletion data/features/dependency-graph-repository-view-update.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@
versions:
fpt: '*'
ghec: '*'
ghes: '>3.9'
ghes: '>= 3.11'
2 changes: 1 addition & 1 deletion data/features/repository-activity-view.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
versions:
fpt: '*'
ghec: '*'
ghes: '> 3.9'
ghes: '>= 3.11'
ghae: '> 3.9'
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
versions:
ghes: '>=3.10'
ghes: '>=3.11'
ghec: '*'
1 change: 1 addition & 0 deletions data/features/security-advisories-rest-api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
versions:
fpt: '*'
ghec: '*'
ghes: '>= 3.11'
3 changes: 3 additions & 0 deletions data/reusables/enterprise-accounts/access-enterprise-ghes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
1. In the top-right corner of {% data variables.product.prodname_ghe_server %}, click your profile photo, then click **Enterprise settings**.

![Screenshot of the drop-down menu that appears when you click the profile photo on GitHub Enterprise Server. The "Enterprise settings" option is highlighted in a dark orange outline.](/assets/images/enterprise/settings/enterprise-settings.png)
4 changes: 1 addition & 3 deletions data/reusables/enterprise-accounts/access-enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,5 @@
1. In the list of enterprises, click the enterprise you want to view.

{%- elsif ghes or ghae %}
1. In the top-right corner of {% data variables.product.product_name %}, click your profile photo, then click **Enterprise settings**.

![Screenshot of the drop-down menu that appears when you click the profile photo on GitHub Enterprise Server. The "Enterprise settings" option is highlighted in a dark orange outline.](/assets/images/enterprise/settings/enterprise-settings.png)
{% data reusables.enterprise-accounts.access-enterprise-ghes %}
{%- endif %}

0 comments on commit e4ee7b1

Please sign in to comment.