зеркало из https://github.com/github/docs.git
Merge branch 'main' into document-npm-run-build
This commit is contained in:
Sarah Schneider
GitHub
Коммит
8b101bdae6
|
|
@ -0,0 +1,59 @@
|
|||
name: Lint JS
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
branches-ignore:
|
||||
- translations
|
||||
|
||||
jobs:
|
||||
see_if_should_skip:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
outputs:
|
||||
should_skip: ${{ steps.skip_check.outputs.should_skip }}
|
||||
steps:
|
||||
- id: skip_check
|
||||
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
|
||||
with:
|
||||
cancel_others: 'false'
|
||||
github_token: ${{ github.token }}
|
||||
paths: '["**/*.js", "package*.json", ".github/workflows/js-lint.yml"]'
|
||||
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
needs: see_if_should_skip
|
||||
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
steps:
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
|
||||
|
||||
- name: Setup node
|
||||
uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
|
||||
with:
|
||||
node-version: 14.x
|
||||
|
||||
- name: Get npm cache directory
|
||||
id: npm-cache
|
||||
run: |
|
||||
echo "::set-output name=dir::$(npm config get cache)"
|
||||
|
||||
- name: Cache node modules
|
||||
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
|
||||
with:
|
||||
path: ${{ steps.npm-cache.outputs.dir }}
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run linter
|
||||
run: npx standard
|
||||
|
||||
- name: Check dependencies
|
||||
run: npm run check-deps
|
||||
|
|
@ -28,48 +28,7 @@ jobs:
|
|||
cancel_others: 'false'
|
||||
github_token: ${{ github.token }}
|
||||
paths: '[".github/workflows/test.yml",".node-version", ".npmrc", "app.json", "content/**", "data/**","lib/**", "Dockerfile", "feature-flags.json", "Gemfile", "Gemfile.lock", "middleware/**", "node_modules/**","package.json", "package-lock.json", "server.js", "tests/**", "translations/**", "Procfile", "webpack.config.js"]'
|
||||
lint:
|
||||
needs: see_if_should_skip
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
|
||||
# Even if if doesn't do anything
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Check out repo
|
||||
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Setup node
|
||||
uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
|
||||
with:
|
||||
node-version: 14.x
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Get npm cache directory
|
||||
id: npm-cache
|
||||
run: |
|
||||
echo "::set-output name=dir::$(npm config get cache)"
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Cache node modules
|
||||
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
|
||||
with:
|
||||
path: ${{ steps.npm-cache.outputs.dir }}
|
||||
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-node-
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Run linter
|
||||
run: npx standard
|
||||
|
||||
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
name: Check dependencies
|
||||
run: npm run check-deps
|
||||
test:
|
||||
needs: see_if_should_skip
|
||||
runs-on: ubuntu-latest
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ on:
|
|||
|
||||
jobs:
|
||||
triage-issue-comments:
|
||||
if: github.repository == 'github/docs'
|
||||
if: github.repository == 'github/docs' && github.event.issue.pull_request == null
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
|
|
|
|||
|
|
@ -89,7 +89,7 @@ A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and
|
|||
When we merge those changes, they should be deployed to the live site within 24 hours. :earth_africa: To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below.
|
||||
|
||||
### :question: Support
|
||||
We are a small team working hard to keep up with the documentation demands of a continously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked.
|
||||
We are a small team working hard to keep up with the documentation demands of a continuously changing product. Unfortunately, we just can't help with support questions in this repository. If you are experiencing a problem with GitHub, unrelated to our documentation, please [contact GitHub Support directly](https://support.github.com/contact). Any issues, discussions, or pull requests opened here requesting support will be given information about how to contact GitHub Support, then closed and locked.
|
||||
|
||||
If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact).
|
||||
|
||||
|
|
@ -129,7 +129,7 @@ Here's some information that might be helpful while working on a Docs PR:
|
|||
|
||||
- [Variables](/data/variables/README.md) - We use variables the same way we use reusables. Variables are for short strings of reusable text.
|
||||
|
||||
- [Liquid](/contribution/liquid-helpers.md) - We use liquid helpers to create different versions of our content.
|
||||
- [Liquid](/contributing/liquid-helpers.md) - We use liquid helpers to create different versions of our content.
|
||||
|
||||
- [Scripts](/script/README.md) - The scripts directory is the home for all of the scripts you can run locally.
|
||||
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ If you've found a problem, you can open an issue using a [template](https://gith
|
|||
|
||||
#### Solve an issue
|
||||
|
||||
If you have a solution to one of the open issues, you will need to fork the repository and submit a PR using the [template](https://github.com/github/docs/blob/main/CONTRIBUTING.md#pull-request-template) that is visible automatically in the pull request body. For more details about this process, please check out [Getting Started with Contributing](/CONTRIBUTING.md).
|
||||
If you have a solution to one of the open issues, you will need to fork the repository and submit a PR using the [template](https://github.com/github/docs/blob/main/CONTRIBUTING.md#pull-request-template) that is visible automatically in the pull request body. For more details about this process, please check out [Getting Started with Contributing](/CONTRIBUTING.md).
|
||||
|
||||
#### Join us in discussions
|
||||
|
||||
|
|
|
|||
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 4.9 KiB |
Двоичный файл не отображается.
|
До Ширина: | Высота: | Размер: 6.4 KiB После Ширина: | Высота: | Размер: 9.2 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 7.8 KiB |
Двоичный файл не отображается.
|
До Ширина: | Высота: | Размер: 82 KiB После Ширина: | Высота: | Размер: 68 KiB |
Двоичный файл не отображается.
|
До Ширина: | Высота: | Размер: 5.3 KiB После Ширина: | Высота: | Размер: 9.9 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 7.9 KiB |
Двоичный файл не отображается.
|
До Ширина: | Высота: | Размер: 79 KiB После Ширина: | Высота: | Размер: 63 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 9.4 KiB |
Двоичные данные
assets/images/help/settings/user-account-temporary-interaction-limits-options.png
Normal file
Двоичные данные
assets/images/help/settings/user-account-temporary-interaction-limits-options.png
Normal file
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 61 KiB |
|
|
@ -21,7 +21,7 @@ This guide shows you how to use PowerShell for CI. It describes how to use Peste
|
|||
You should be familiar with YAML and the syntax for {% data variables.product.prodname_actions %}. For more information, see "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)."
|
||||
|
||||
We recommend that you have a basic understanding of PowerShell and Pester. For more information, see:
|
||||
- [Getting started with PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/learn/ps101/01-getting-started)
|
||||
- [Getting started with PowerShell](https://docs.microsoft.com/powershell/scripting/learn/ps101/01-getting-started)
|
||||
- [Pester](https://pester.dev)
|
||||
|
||||
{% data reusables.actions.enterprise-setup-prereq %}
|
||||
|
|
@ -85,7 +85,7 @@ The table below describes the locations for various PowerShell modules in each {
|
|||
|
||||
{% note %}
|
||||
|
||||
**Note:** The pre-installed packages (such as Pester) used by {% data variables.product.prodname_dotcom %}-hosted runners are regularly updated, and can introduce signficant changes. As a result, it is recommended that you always specify the required package versions by using `Install-Module` with `-MaximumVersion`.
|
||||
**Note:** The pre-installed packages (such as Pester) used by {% data variables.product.prodname_dotcom %}-hosted runners are regularly updated, and can introduce significant changes. As a result, it is recommended that you always specify the required package versions by using `Install-Module` with `-MaximumVersion`.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
|
|||
|
|
@ -171,12 +171,12 @@ Jobs that are dependent on a previous job's artifacts must wait for the dependen
|
|||
|
||||
Job 1 performs these steps:
|
||||
- Performs a math calculation and saves the result to a text file called `math-homework.txt`.
|
||||
- Uses the `upload-artifact` action to upload the `math-homework.txt` file with the name `homework`. The action places the file in a directory named `homework`.
|
||||
- Uses the `upload-artifact` action to upload the `math-homework.txt` file with the artifact name `homework`.
|
||||
|
||||
Job 2 uses the result in the previous job:
|
||||
- Downloads the `homework` artifact uploaded in the previous job. By default, the `download-artifact` action downloads artifacts to the workspace directory that the step is executing in. You can use the `path` input parameter to specify a different download directory.
|
||||
- Reads the value in the `homework/math-homework.txt` file, performs a math calculation, and saves the result to `math-homework.txt`.
|
||||
- Uploads the `math-homework.txt` file. This upload overwrites the previous upload because both of the uploads share the same name.
|
||||
- Reads the value in the `math-homework.txt` file, performs a math calculation, and saves the result to `math-homework.txt` again, overwriting its contents.
|
||||
- Uploads the `math-homework.txt` file. This upload overwrites the previously uploaded artifact because they share the same name.
|
||||
|
||||
Job 3 displays the result uploaded in the previous job:
|
||||
- Downloads the `homework` artifact.
|
||||
|
|
|
|||
|
|
@ -111,6 +111,7 @@ You must ensure that the machine has the appropriate network access to communica
|
|||
github.com
|
||||
api.github.com
|
||||
*.actions.githubusercontent.com
|
||||
codeload.github.com
|
||||
```
|
||||
|
||||
If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)" or "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#using-github-actions-with-an-ip-allow-list)".
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ Jobs and steps in Azure Pipelines are very similar to jobs and steps in {% data
|
|||
|
||||
### Migrating script steps
|
||||
|
||||
You can run a script or a shell command as a step in a workflow. In Azure Pipelines, script steps can be specified using the `script` key, or with the `bash`, `powershell`, or `pwsh` keys. Scripts can also be specified as an input to the [Bash task](https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/utility/bash?view=azure-devops) or the [PowerShell task](https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/utility/powershell?view=azure-devops).
|
||||
You can run a script or a shell command as a step in a workflow. In Azure Pipelines, script steps can be specified using the `script` key, or with the `bash`, `powershell`, or `pwsh` keys. Scripts can also be specified as an input to the [Bash task](https://docs.microsoft.com/azure/devops/pipelines/tasks/utility/bash?view=azure-devops) or the [PowerShell task](https://docs.microsoft.com/azure/devops/pipelines/tasks/utility/powershell?view=azure-devops).
|
||||
|
||||
In {% data variables.product.prodname_actions %}, all scripts are specified using the `run` key. To select a particular shell, you can specify the `shell` key when providing the script. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepsrun)."
|
||||
|
||||
|
|
|
|||
|
|
@ -180,7 +180,7 @@ GitLab CI/CD
|
|||
deploy_prod:
|
||||
stage: deploy
|
||||
script:
|
||||
- echo "Deply to production server"
|
||||
- echo "Deploy to production server"
|
||||
rules:
|
||||
- if: '$CI_COMMIT_BRANCH == "master"'
|
||||
```
|
||||
|
|
@ -194,7 +194,7 @@ jobs:
|
|||
if: contains( github.ref, 'master')
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: echo "Deply to production server"
|
||||
- run: echo "Deploy to production server"
|
||||
```
|
||||
{% endraw %}
|
||||
</td>
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Secrets use [Libsodium sealed boxes](https://libsodium.gitbook.io/doc/public-key
|
|||
To help prevent accidental disclosure, {% data variables.product.product_name %} uses a mechanism that attempts to redact any secrets that appear in run logs. This redaction looks for exact matches of any configured secrets, as well as common encodings of the values, such as Base64. However, because there are multiple ways a secret value can be transformed, this redaction is not guaranteed. As a result, there are certain proactive steps and good practices you should follow to help ensure secrets are redacted, and to limit other risks associated with secrets:
|
||||
|
||||
- **Never use structured data as a secret**
|
||||
- Unstructured data can cause secret redaction within logs to fail, because redaction largely relies on finding an exact match for the specific secret value. For example, do not use a blob of JSON, XML, or YAML (or similar) to encapsulate a secret value, as this significantly reduces the probability the secrets will be properly redacted. Instead, create individual secrets for each sensitive value.
|
||||
- Structured data can cause secret redaction within logs to fail, because redaction largely relies on finding an exact match for the specific secret value. For example, do not use a blob of JSON, XML, or YAML (or similar) to encapsulate a secret value, as this significantly reduces the probability the secrets will be properly redacted. Instead, create individual secrets for each sensitive value.
|
||||
- **Register all secrets used within workflows**
|
||||
- If a secret is used to generate another sensitive value within a workflow, that generated value should be formally [registered as a secret](https://github.com/actions/toolkit/tree/main/packages/core#setting-a-secret), so that it will be redacted if it ever appears in the logs. For example, if using a private key to generate a signed JWT to access a web API, be sure to register that JWT as a secret or else it won’t be redacted if it ever enters the log output.
|
||||
- Registering secrets applies to any sort of transformation/encoding as well. If your secret is transformed in some way (such as Base64 or URL-encoded), be sure to register the new value as a secret too.
|
||||
|
|
@ -98,7 +98,7 @@ You should also consider the environment of the self-hosted runner machines:
|
|||
|
||||
### Auditing {% data variables.product.prodname_actions %} events
|
||||
|
||||
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.
|
||||
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 performed the action.
|
||||
|
||||
For example, you can use the audit log to track the `action:org.update_actions_secret` event, which tracks changes to organization secrets:
|
||||
|
||||
|
|
|
|||
|
|
@ -106,7 +106,7 @@ steps:
|
|||
```
|
||||
{% endraw %}
|
||||
|
||||
Avoid passing secrets between processes from the command line, whenever possible. Command-line processes may be visible to other users (using the `ps` command) or captured by [security audit events](https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing). To help protect secrets, consider using environment variables, `STDIN`, or other mechanisms supported by the target process.
|
||||
Avoid passing secrets between processes from the command line, whenever possible. Command-line processes may be visible to other users (using the `ps` command) or captured by [security audit events](https://docs.microsoft.com/windows-server/identity/ad-ds/manage/component-updates/command-line-process-auditing). To help protect secrets, consider using environment variables, `STDIN`, or other mechanisms supported by the target process.
|
||||
|
||||
If you must pass secrets within a command line, then enclose them within the proper quoting rules. Secrets often contain special characters that may unintentionally affect your shell. To escape these special characters, use quoting with your environment variables. For example:
|
||||
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ You can manually trigger a workflow run using the {% data variables.product.prod
|
|||
|
||||
##### Example workflow configuration
|
||||
|
||||
This example defines the `name` and `home` inputs and prints them using the `github.event.inputs.name` and `github.event.inputs.home` contexts. If a `name` isn't provided, the default value 'Mona the Octocat' is printed.
|
||||
This example defines the `name` and `home` inputs and prints them using the `github.event.inputs.name` and `github.event.inputs.home` contexts. If a `home` isn't provided, the default value 'The Octoverse' is printed.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
|
|
@ -115,6 +115,7 @@ on:
|
|||
home:
|
||||
description: 'location'
|
||||
required: false
|
||||
default: 'The Octoverse'
|
||||
|
||||
jobs:
|
||||
say_hello:
|
||||
|
|
@ -314,6 +315,33 @@ on:
|
|||
types: [created, deleted]
|
||||
```
|
||||
|
||||
The `issue_comment` event occurs for comments on both issues and pull requests. To determine whether the `issue_comment` event was triggered from an issue or pull request, you can check the event payload for the `issue.pull_request` property and use it as a condition to skip a job.
|
||||
|
||||
For example, you can choose to run the `pr_commented` job when comment events occur in a pull request, and the `issue_commented` job when comment events occur in an issue.
|
||||
|
||||
```yaml
|
||||
on: issue_comment
|
||||
|
||||
jobs:
|
||||
pr_commented:
|
||||
# This job only runs for pull request comments
|
||||
name: PR comment
|
||||
if: ${{ github.event.issue.pull_request }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: |
|
||||
echo "Comment on PR #${{ github.event.issue.number }}"
|
||||
|
||||
issue-commented:
|
||||
# This job only runs for issue comments
|
||||
name: Issue comment
|
||||
if: ${{ !github.event.issue.pull_request }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: |
|
||||
echo "Comment on issue #${{ github.event.issue.number }}"
|
||||
```
|
||||
|
||||
#### `issues`
|
||||
|
||||
Runs your workflow anytime the `issues` event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "[Issues](/v3/issues)."
|
||||
|
|
@ -655,6 +683,10 @@ on:
|
|||
|
||||
{% data reusables.webhooks.workflow_run_desc %}
|
||||
|
||||
| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
|
||||
| --------------------- | -------------- | ------------ | -------------|
|
||||
| [`workflow_run`](/webhooks/event-payloads/#workflow_run) | - n/a | Last commit on default branch | Default branch |
|
||||
|
||||
If you need to filter branches from this event, you can use `branches` or `branches-ignore`.
|
||||
|
||||
In this example, a workflow is configured to run after the separate “Run Tests” workflow completes.
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ You can specify the runner type for each job in a workflow. Each job in a workfl
|
|||
|
||||
#### Cloud hosts for {% data variables.product.prodname_dotcom %}-hosted runners
|
||||
|
||||
{% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on Standard_DS2_v2 virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. For more information about the Standard_DS2_v2 machine resources, see "[Dv2 and DSv2-series](https://docs.microsoft.com/en-us/azure/virtual-machines/dv2-dsv2-series#dsv2-series)" in the Microsoft Azure documentation.
|
||||
{% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on Standard_DS2_v2 virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. For more information about the Standard_DS2_v2 machine resources, see "[Dv2 and DSv2-series](https://docs.microsoft.com/azure/virtual-machines/dv2-dsv2-series#dsv2-series)" in the Microsoft Azure documentation.
|
||||
|
||||
{% data variables.product.prodname_dotcom %} uses [MacStadium](https://www.macstadium.com/) to host the macOS runners.
|
||||
|
||||
|
|
@ -37,7 +37,7 @@ You can specify the runner type for each job in a workflow. Each job in a workfl
|
|||
|
||||
The Linux and macOS virtual machines both run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)."
|
||||
|
||||
Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/en-us/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation.
|
||||
Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation.
|
||||
|
||||
### Supported runners and hardware resources
|
||||
|
||||
|
|
|
|||
|
|
@ -65,22 +65,22 @@ You can use the `set-output` command in your workflow to set the same value:
|
|||
|
||||
The following table shows which toolkit functions are available within a workflow:
|
||||
|
||||
| Toolkit function| Equivalent workflow command|
|
||||
| ------------- | ------------- |
|
||||
| `core.addPath` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_PATH`{% else %} `add-path` {% endif %} |
|
||||
| `core.debug` | `debug` |
|
||||
| `core.error` | `error` |
|
||||
| `core.endGroup` | `endgroup` |
|
||||
| `core.exportVariable` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_ENV`{% else %} `set-env` {% endif %} |
|
||||
| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` |
|
||||
| `core.getState` | Accessible using environment variable `STATE_{NAME}` |
|
||||
| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` |
|
||||
| `core.saveState` | `save-state` |
|
||||
| `core.setFailed` | Used as a shortcut for `::error` and `exit 1` |
|
||||
| `core.setOutput` | `set-output` |
|
||||
| `core.setSecret` | `add-mask` |
|
||||
| `core.startGroup` | `group` |
|
||||
| `core.warning` | `warning file` |
|
||||
| Toolkit function | Equivalent workflow command |
|
||||
| ----------------- | ------------- |
|
||||
| `core.addPath` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_PATH`{% else %} `add-path` {% endif %} |
|
||||
| `core.debug` | `debug` |
|
||||
| `core.error` | `error` |
|
||||
| `core.endGroup` | `endgroup` |
|
||||
| `core.exportVariable` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_ENV`{% else %} `set-env` {% endif %} |
|
||||
| `core.getInput` | Accessible using environment variable `INPUT_{NAME}` |
|
||||
| `core.getState` | Accessible using environment variable `STATE_{NAME}` |
|
||||
| `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` |
|
||||
| `core.saveState` | `save-state` |
|
||||
| `core.setFailed` | Used as a shortcut for `::error` and `exit 1` |
|
||||
| `core.setOutput` | `set-output` |
|
||||
| `core.setSecret` | `add-mask` |
|
||||
| `core.startGroup` | `group` |
|
||||
| `core.warning` | `warning file` |
|
||||
|
||||
{% if currentVersion ver_lt "enterprise-server@2.23" %}
|
||||
### Setting an environment variable
|
||||
|
|
@ -160,6 +160,25 @@ Creates an error message and prints the message to the log. You can optionally p
|
|||
echo "::error file=app.js,line=10,col=15::Something went wrong"
|
||||
```
|
||||
|
||||
### Grouping log lines
|
||||
|
||||
```
|
||||
::group::{title}
|
||||
::endgroup::
|
||||
```
|
||||
|
||||
Creates an expandable group in the log. To create a group, use the `group` command and specify a `title`. Anything you print to the log between the `group` and `endgroup` commands is nested inside an expandable entry in the log.
|
||||
|
||||
#### Example
|
||||
|
||||
```bash
|
||||
echo "::group::My title"
|
||||
echo "Inside group"
|
||||
echo "::endgroup::"
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Masking a value in log
|
||||
|
||||
`::add-mask::{value}`
|
||||
|
|
@ -255,7 +274,8 @@ echo "action_state=yellow" >> $GITHUB_ENV
|
|||
|
||||
Running `$action_state` in a future step will now return `yellow`
|
||||
|
||||
#### Multline strings
|
||||
#### Multiline strings
|
||||
|
||||
For multiline strings, you may use a delimiter with the following syntax.
|
||||
|
||||
```
|
||||
|
|
@ -264,7 +284,8 @@ For multiline strings, you may use a delimiter with the following syntax.
|
|||
{delimiter}
|
||||
```
|
||||
|
||||
#### Example
|
||||
##### Example
|
||||
|
||||
In this example, we use `EOF` as a delimiter and set the `JSON_RESPONSE` environment variable to the value of the curl response.
|
||||
```
|
||||
steps:
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ versions:
|
|||
|
||||
### About authentication and user provisioning with Azure AD
|
||||
|
||||
Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs.
|
||||
Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs.
|
||||
|
||||
To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access with SCIM. This configuration allows you to assign or unassign the {% data variables.product.prodname_ghe_managed %} application for a user account in your Azure AD tenant to automatically create, grant access to, or deactivate a corresponding user account on {% data variables.product.product_name %}.
|
||||
|
||||
|
|
@ -18,9 +18,9 @@ For more information about managing identity and access for your enterprise on {
|
|||
|
||||
### Prerequisites
|
||||
|
||||
To configure authentication and user provisioning for {% data variables.product.product_name %} using Azure AD, you must have an Azure AD account and tenant. For more information, see the [Azure AD website](https://azure.microsoft.com/en-us/free/active-directory) and [Quickstart: Create an Azure Active Directory tenant](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-create-new-tenant) in the Microsoft Docs.
|
||||
To configure authentication and user provisioning for {% data variables.product.product_name %} using Azure AD, you must have an Azure AD account and tenant. For more information, see the [Azure AD website](https://azure.microsoft.com/free/active-directory) and [Quickstart: Create an Azure Active Directory tenant](https://docs.microsoft.com/azure/active-directory/develop/quickstart-create-new-tenant) in the Microsoft Docs.
|
||||
|
||||
{% data reusables.saml.assert-the-administrator-attribute %} For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs.
|
||||
{% data reusables.saml.assert-the-administrator-attribute %} For more information about including the `administrator` attribute in the SAML claim from Azure AD, see [How to: customize claims issued in the SAML token for enterprise applications](https://docs.microsoft.com/azure/active-directory/develop/active-directory-saml-claims-customization) in the Microsoft Docs.
|
||||
|
||||
{% data reusables.saml.create-a-machine-user %}
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ Each {% data variables.product.prodname_ghe_server %} username is determined by
|
|||
|
||||
The `NameID` element is required even if other attributes are present.
|
||||
|
||||
A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecyle of the user.
|
||||
A mapping is created between the `NameID` and the {% data variables.product.prodname_ghe_server %} username, so the `NameID` should be persistent, unique, and not subject to change for the lifecycle of the user.
|
||||
|
||||
{% note %}
|
||||
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ There are two types of snapshots:
|
|||
| Platform | Snapshot method | Snapshot documentation URL |
|
||||
|---|---|---|
|
||||
| Amazon AWS | Disk | <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-snapshot.html>
|
||||
| Azure | VM | <https://azure.microsoft.com/en-us/documentation/articles/backup-azure-vms/>
|
||||
| Azure | VM | <https://docs.microsoft.com/azure/backup/backup-azure-vms-first-look-arm>
|
||||
| Hyper-V | VM | <https://docs.microsoft.com/windows-server/virtualization/hyper-v/manage/enable-or-disable-checkpoints-in-hyper-v>
|
||||
| Google Compute Engine | Disk | <https://cloud.google.com/compute/docs/disks/create-snapshots>
|
||||
| VMware | VM | <https://pubs.vmware.com/vsphere-50/topic/com.vmware.wssdk.pg.doc_50/PG_Ch11_VM_Manage.13.3.html>
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ After submitting your support request and optional diagnostic information, {% da
|
|||
{% if currentVersion == "github-ae@latest" %}
|
||||
### Submitting a ticket using the {% data variables.contact.ae_azure_portal %}
|
||||
|
||||
Commercial customers can submit a support request in the {% data variables.contact.contact_ae_portal %}. Government customers should use the [Azure portal for government customers](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade). For more information, see [Create an Azure support request](https://docs.microsoft.com/en-us/azure/azure-portal/supportability/how-to-create-azure-support-request) in the Microsoft documentation.
|
||||
Commercial customers can submit a support request in the {% data variables.contact.contact_ae_portal %}. Government customers should use the [Azure portal for government customers](https://portal.azure.us/#blade/Microsoft_Azure_Support/HelpAndSupportBlade). For more information, see [Create an Azure support request](https://docs.microsoft.com/azure/azure-portal/supportability/how-to-create-azure-support-request) in the Microsoft documentation.
|
||||
|
||||
For urgent issues, to ensure a quick response, after you submit a ticket, please call the support hotline immediately. Your Technical Support Account Manager (TSAM) will provide you with the number to use in your onboarding session.
|
||||
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ You can deploy {% data variables.product.prodname_ghe_server %} on global Azure
|
|||
|
||||
- {% data reusables.enterprise_installation.software-license %}
|
||||
- You must have an Azure account capable of provisioning new machines. For more information, see the [Microsoft Azure website](https://azure.microsoft.com).
|
||||
- Most actions needed to launch your virtual machine (VM) may also be performed using the Azure Portal. However, we recommend installing the Azure command line interface (CLI) for initial setup. Examples using the Azure CLI 2.0 are included below. For more information, see Azure's guide "[Install Azure CLI 2.0](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)."
|
||||
- Most actions needed to launch your virtual machine (VM) may also be performed using the Azure Portal. However, we recommend installing the Azure command line interface (CLI) for initial setup. Examples using the Azure CLI 2.0 are included below. For more information, see Azure's guide "[Install Azure CLI 2.0](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest)."
|
||||
|
||||
### Hardware considerations
|
||||
|
||||
|
|
@ -26,9 +26,9 @@ Before launching {% data variables.product.product_location %} on Azure, you'll
|
|||
|
||||
#### Supported VM types and regions
|
||||
|
||||
The {% data variables.product.prodname_ghe_server %} appliance requires a premium storage data disk, and is supported on any Azure VM that supports premium storage. For more information, see "[Supported VMs](https://docs.microsoft.com/en-us/azure/storage/common/storage-premium-storage#supported-vms)" in the Azure documentation. For general information about available VMs, see [the Azure virtual machines overview page](http://azure.microsoft.com/en-us/pricing/details/virtual-machines/#Linux).
|
||||
The {% data variables.product.prodname_ghe_server %} appliance requires a premium storage data disk, and is supported on any Azure VM that supports premium storage. For more information, see "[Supported VMs](https://docs.microsoft.com/azure/storage/common/storage-premium-storage#supported-vms)" in the Azure documentation. For general information about available VMs, see [the Azure virtual machines overview page](https://azure.microsoft.com/pricing/details/virtual-machines/#Linux).
|
||||
|
||||
{% data variables.product.prodname_ghe_server %} supports any region that supports your VM type. For more information about the supported regions for each VM, see Azure's "[Products available by region](https://azure.microsoft.com/en-us/regions/services/)."
|
||||
{% data variables.product.prodname_ghe_server %} supports any region that supports your VM type. For more information about the supported regions for each VM, see Azure's "[Products available by region](https://azure.microsoft.com/regions/services/)."
|
||||
|
||||
#### Recommended VM types
|
||||
|
||||
|
|
@ -47,20 +47,20 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
|
|||
|
||||
{% data reusables.enterprise_installation.create-ghe-instance %}
|
||||
|
||||
1. Find the most recent {% data variables.product.prodname_ghe_server %} appliance image. For more information about the `vm image list` command, see "[az vm image list](https://docs.microsoft.com/en-us/cli/azure/vm/image?view=azure-cli-latest#az_vm_image_list)" in the Microsoft documentation.
|
||||
1. Find the most recent {% data variables.product.prodname_ghe_server %} appliance image. For more information about the `vm image list` command, see "[az vm image list](https://docs.microsoft.com/cli/azure/vm/image?view=azure-cli-latest#az_vm_image_list)" in the Microsoft documentation.
|
||||
```shell
|
||||
$ az vm image list --all -f GitHub-Enterprise | grep '"urn":' | sort -V
|
||||
```
|
||||
|
||||
2. Create a new VM using the appliance image you found. For more information, see "[az vm create](https://docs.microsoft.com/en-us/cli/azure/vm?view=azure-cli-latest#az_vm_create)" in the Microsoft documentation.
|
||||
2. Create a new VM using the appliance image you found. For more information, see "[az vm create](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_create)" in the Microsoft documentation.
|
||||
|
||||
Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "[Resource groups](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview#resource-groups)" in the Microsoft documentation.
|
||||
Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "[Resource groups](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-overview#resource-groups)" in the Microsoft documentation.
|
||||
|
||||
```shell
|
||||
$ az vm create -n <em>VM_NAME</em> -g <em>RESOURCE_GROUP</em> --size <em>VM_SIZE</em> -l <em>REGION</em> --image <em>APPLIANCE_IMAGE_NAME</em> --storage-sku Premium_LRS
|
||||
```
|
||||
|
||||
3. Configure the security settings on your VM to open up required ports. For more information, see "[az vm open-port](https://docs.microsoft.com/en-us/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.
|
||||
3. Configure the security settings on your VM to open up required ports. For more information, see "[az vm open-port](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open.
|
||||
|
||||
```shell
|
||||
$ az vm open-port -n <em>VM_NAME</em> -g <em>RESOURCE_GROUP</em> --port <em>PORT_NUMBER</em>
|
||||
|
|
@ -70,7 +70,7 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
|
|||
|
||||
{% data reusables.enterprise_installation.necessary_ports %}
|
||||
|
||||
4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/en-us/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation.
|
||||
4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation.
|
||||
|
||||
Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `100`), and a name for the resulting VHD.
|
||||
|
||||
|
|
@ -86,7 +86,7 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
|
|||
|
||||
### Configuring the {% data variables.product.prodname_ghe_server %} virtual machine
|
||||
|
||||
1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the `vm list` command. For more information, see "[az vm list](https://docs.microsoft.com/en-us/cli/azure/vm?view=azure-cli-latest#az_vm_list)" in the Microsoft documentation.
|
||||
1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the `vm list` command. For more information, see "[az vm list](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_list)" in the Microsoft documentation.
|
||||
```shell
|
||||
$ az vm list -d -g <em>RESOURCE_GROUP</em> -o table
|
||||
> Name ResourceGroup PowerState PublicIps Fqdns Location Zones
|
||||
|
|
@ -96,7 +96,7 @@ We recommend you use a DS v2 instance type with at least 14 GB of RAM. You can u
|
|||
```
|
||||
{% note %}
|
||||
|
||||
**Note:** Azure does not automatically create a FQDNS entry for the VM. For more information, see Azure's guide on how to "[Create a fully qualified domain name in the Azure portal for a Linux VM](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/portal-create-fqdn)."
|
||||
**Note:** Azure does not automatically create a FQDNS entry for the VM. For more information, see Azure's guide on how to "[Create a fully qualified domain name in the Azure portal for a Linux VM](https://docs.microsoft.com/azure/virtual-machines/linux/portal-create-fqdn)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ versions:
|
|||
|
||||
- {% data reusables.enterprise_installation.software-license %}
|
||||
- You must have Windows Server 2008 through Windows Server 2016, which support Hyper-V.
|
||||
- Most actions needed to create your virtual machine (VM) may also be performed using the [Hyper-V Manager](https://docs.microsoft.com/en-us/windows-server/virtualization/hyper-v/manage/remotely-manage-hyper-v-hosts). However, we recommend using the Windows PowerShell command-line shell for initial setup. Examples using PowerShell are included below. For more information, see the Microsoft guide "[Getting Started with Windows PowerShell](https://docs.microsoft.com/en-us/powershell/scripting/getting-started/getting-started-with-windows-powershell?view=powershell-5.1)."
|
||||
- Most actions needed to create your virtual machine (VM) may also be performed using the [Hyper-V Manager](https://docs.microsoft.com/windows-server/virtualization/hyper-v/manage/remotely-manage-hyper-v-hosts). However, we recommend using the Windows PowerShell command-line shell for initial setup. Examples using PowerShell are included below. For more information, see the Microsoft guide "[Getting Started with Windows PowerShell](https://docs.microsoft.com/powershell/scripting/getting-started/getting-started-with-windows-powershell?view=powershell-5.1)."
|
||||
|
||||
### Hardware considerations
|
||||
|
||||
|
|
@ -30,23 +30,23 @@ versions:
|
|||
|
||||
{% data reusables.enterprise_installation.create-ghe-instance %}
|
||||
|
||||
1. In PowerShell, create a new Generation 1 virtual machine, configure the size based on your user license count, and attach the {% data variables.product.prodname_ghe_server %} image you downloaded. For more information, see "[New-VM](https://docs.microsoft.com/en-us/powershell/module/hyper-v/new-vm?view=win10-ps)" in the Microsoft documentation.
|
||||
1. In PowerShell, create a new Generation 1 virtual machine, configure the size based on your user license count, and attach the {% data variables.product.prodname_ghe_server %} image you downloaded. For more information, see "[New-VM](https://docs.microsoft.com/powershell/module/hyper-v/new-vm?view=win10-ps)" in the Microsoft documentation.
|
||||
```shell
|
||||
PS C:\> New-VM -Generation 1 -Name <em>VM_NAME</em> -MemoryStartupBytes <em>MEMORY_SIZE</em> -BootDevice VHD -VHDPath <em>PATH_TO_VHD</em>
|
||||
```
|
||||
{% data reusables.enterprise_installation.create-attached-storage-volume %} Replace `PATH_TO_DATA_DISK` with the path to the location where you create the disk. For more information, see "[New-VHD](https://docs.microsoft.com/en-us/powershell/module/hyper-v/new-vhd?view=win10-ps)" in the Microsoft documentation.
|
||||
{% data reusables.enterprise_installation.create-attached-storage-volume %} Replace `PATH_TO_DATA_DISK` with the path to the location where you create the disk. For more information, see "[New-VHD](https://docs.microsoft.com/powershell/module/hyper-v/new-vhd?view=win10-ps)" in the Microsoft documentation.
|
||||
```shell
|
||||
PS C:\> New-VHD -Path <em>PATH_TO_DATA_DISK</em> -SizeBytes <em>DISK_SIZE</em>
|
||||
```
|
||||
3. Attach the data disk to your instance. For more information, see "[Add-VMHardDiskDrive](https://docs.microsoft.com/en-us/powershell/module/hyper-v/add-vmharddiskdrive?view=win10-ps)" in the Microsoft documentation.
|
||||
3. Attach the data disk to your instance. For more information, see "[Add-VMHardDiskDrive](https://docs.microsoft.com/powershell/module/hyper-v/add-vmharddiskdrive?view=win10-ps)" in the Microsoft documentation.
|
||||
```shell
|
||||
PS C:\> Add-VMHardDiskDrive -VMName <em>VM_NAME</em> -Path <em>PATH_TO_DATA_DISK</em>
|
||||
```
|
||||
4. Start the VM. For more information, see "[Start-VM](https://docs.microsoft.com/en-us/powershell/module/hyper-v/start-vm?view=win10-ps)" in the Microsoft documentation.
|
||||
4. Start the VM. For more information, see "[Start-VM](https://docs.microsoft.com/powershell/module/hyper-v/start-vm?view=win10-ps)" in the Microsoft documentation.
|
||||
```shell
|
||||
PS C:\> Start-VM -Name <em>VM_NAME</em>
|
||||
```
|
||||
5. Get the IP address of your VM. For more information, see "[Get-VMNetworkAdapter](https://docs.microsoft.com/en-us/powershell/module/hyper-v/get-vmnetworkadapter?view=win10-ps)" in the Microsoft documentation.
|
||||
5. Get the IP address of your VM. For more information, see "[Get-VMNetworkAdapter](https://docs.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapter?view=win10-ps)" in the Microsoft documentation.
|
||||
```shell
|
||||
PS C:\> (Get-VMNetworkAdapter -VMName <em>VM_NAME</em>).IpAddresses
|
||||
```
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ versions:
|
|||
|
||||
{% data variables.product.prodname_registry %} on {% data variables.product.prodname_ghe_server %} uses external blob storage to store your packages. The amount of storage required depends on your usage of {% data variables.product.prodname_registry %}.
|
||||
|
||||
At this time, {% data variables.product.prodname_registry %} supports blob storage with Amazon Web Services (AWS) S3. MinIO is also supported, but configuration is not currently implemented in the {% data variables.product.product_name %} interface. You can use MinIO for storage by following the instructions for AWS S3, entering the analagous information for your MinIO configuration.
|
||||
At this time, {% data variables.product.prodname_registry %} supports blob storage with Amazon Web Services (AWS) S3. MinIO is also supported, but configuration is not currently implemented in the {% data variables.product.product_name %} interface. You can use MinIO for storage by following the instructions for AWS S3, entering the analogous information for your MinIO configuration.
|
||||
|
||||
For the best experience, we recommend using a dedicated bucket for {% data variables.product.prodname_registry %}, separate from the bucket you use for {% data variables.product.prodname_actions %} storage.
|
||||
|
||||
|
|
|
|||
|
|
@ -66,9 +66,9 @@ You can only use a {% data variables.product.product_name %} username, not an in
|
|||
|
||||
The `org` qualifier limits actions to a specific organization. For example:
|
||||
|
||||
* `org:my-org` finds all events that occured for the `my-org` organization.
|
||||
* `org:my-org` finds all events that occurred for the `my-org` organization.
|
||||
* `org:my-org action:team` finds all team events performed within the `my-org` organization.
|
||||
* `-org:my-org` excludes all events that occured for the `my-org` organization.
|
||||
* `-org:my-org` excludes all events that occurred for the `my-org` organization.
|
||||
|
||||
#### Search based on the action performed
|
||||
|
||||
|
|
|
|||
|
|
@ -836,7 +836,7 @@ Here are a few common problems and some suggested solutions. If you run into any
|
|||
|
||||
* **Q:** My app isn't pushing code to GitHub. I don't see the fixes that RuboCop automatically makes!
|
||||
|
||||
**A:** Make sure you have **Read & write** permissions for "Repository contents," and that you are cloning the repository with your intallation token. See [Step 2.2. Cloning the repository](#step-22-cloning-the-repository) for details.
|
||||
**A:** Make sure you have **Read & write** permissions for "Repository contents," and that you are cloning the repository with your installation token. See [Step 2.2. Cloning the repository](#step-22-cloning-the-repository) for details.
|
||||
|
||||
* **Q:** I see an error in the `template_server.rb` debug output related to cloning my repository.
|
||||
|
||||
|
|
|
|||
|
|
@ -662,7 +662,7 @@ While most of your API interaction should occur using your server-to-server inst
|
|||
* [Create commit signature protection](/v3/repos/branches/#create-commit-signature-protection)
|
||||
* [Delete commit signature protection](/v3/repos/branches/#delete-commit-signature-protection)
|
||||
* [Get status checks protection](/v3/repos/branches/#get-status-checks-protection)
|
||||
* [Update status check potection](/v3/repos/branches/#update-status-check-potection)
|
||||
* [Update status check protection](/v3/repos/branches/#update-status-check-protection)
|
||||
* [Remove status check protection](/v3/repos/branches/#remove-status-check-protection)
|
||||
* [Get all status check contexts](/v3/repos/branches/#get-all-status-check-contexts)
|
||||
* [Add status check contexts](/v3/repos/branches/#add-status-check-contexts)
|
||||
|
|
|
|||
|
|
@ -262,7 +262,7 @@ Before you can use the Octokit.rb library to make API calls, you'll need to init
|
|||
# Instantiate an Octokit client authenticated as a GitHub App.
|
||||
# GitHub App authentication requires that you construct a
|
||||
# JWT (https://jwt.io/introduction/) signed with the app's private key,
|
||||
# so GitHub can be sure that it came from the app an not altererd by
|
||||
# so GitHub can be sure that it came from the app an not altered by
|
||||
# a malicious third party.
|
||||
def authenticate_app
|
||||
payload = {
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: REST endpoints for the GitHub Marketplace API
|
||||
intro: 'To help manage your app on {% data variables.product.prodname_marketplace %}, use these {% data variables.product.prodname_marketplace %} API endoints.'
|
||||
intro: 'To help manage your app on {% data variables.product.prodname_marketplace %}, use these {% data variables.product.prodname_marketplace %} API endpoints.'
|
||||
redirect_from:
|
||||
- /apps/marketplace/github-marketplace-api-endpoints/
|
||||
- /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints/
|
||||
|
|
|
|||
|
|
@ -55,10 +55,10 @@ There are several types of data that applications can request.
|
|||
| Type of data | Description |
|
||||
| --- | --- |
|
||||
| Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they <em>can</em> read and write status information against a specific commit. |
|
||||
| Deployments | Deployment status access allows applicationss to determine if a deployment is successful against a specific commit for public and private repositories. Applicationss won't have access to your code. |
|
||||
| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for public and private repositories. Applications won't have access to your code. |
|
||||
| Gists | [Gist](https://gist.github.com) access allows applications to read or write to both your public and secret Gists. |
|
||||
| Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. |
|
||||
| Notifications | Notification access allows applicationss to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. |
|
||||
| Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. |
|
||||
| Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. |
|
||||
| Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. |
|
||||
| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either public or private repositories on a user-wide level. |
|
||||
|
|
|
|||
|
|
@ -37,6 +37,7 @@ versions:
|
|||
{% link_in_list /managing-disruptive-comments %}
|
||||
{% link_in_list /locking-conversations %}
|
||||
{% link_in_list /limiting-interactions-in-your-repository %}
|
||||
{% link_in_list /limiting-interactions-for-your-user-account %}
|
||||
{% link_in_list /limiting-interactions-in-your-organization %}
|
||||
{% link_in_list /tracking-changes-in-a-comment %}
|
||||
{% link_in_list /managing-how-contributors-report-abuse-in-your-organizations-repository %}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
title: Limiting interactions for your user account
|
||||
intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your user account.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: Anyone can limit interactions for their own user account.
|
||||
---
|
||||
|
||||
### About temporary interaction limits
|
||||
|
||||
Limiting interactions for your user account enables temporary interaction limits for all public repositories owned by your user account. {% data reusables.community.interaction-limits-restrictions %}
|
||||
|
||||
{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your public repositories.
|
||||
|
||||
{% data reusables.community.types-of-interaction-limits %}
|
||||
|
||||
When you enable user-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
|
||||
|
||||
You can also block users. For more information, see "[Blocking a user from your personal account](/github/building-a-strong-community/blocking-a-user-from-your-personal-account)."
|
||||
|
||||
### Limiting interactions for your user account
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
1. In your user settings sidebar, under "Moderation settings", click **Interaction limits**.
|
||||
|
||||
{% data reusables.community.set-interaction-limit %}
|
||||
|
||||
|
|
@ -1,31 +1,39 @@
|
|||
---
|
||||
title: Limiting interactions in your organization
|
||||
intro: 'Organization owners can temporarily restrict certain users from commenting, opening issues, or creating pull requests in the organization''s public repositories to enforce a period of limited activity.'
|
||||
intro: 'You can temporarily enforce a period of limited activity for certain users in all public repositories owned by your organization.'
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-organizations-and-teams/limiting-interactions-in-your-organization
|
||||
- /articles/limiting-interactions-in-your-organization
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: Organization owners can limit interactions in an organization.
|
||||
---
|
||||
|
||||
After 24 hours, users can resume normal activity in your organization's public repositories. When you enable organization-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on per-repository activity limitation, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
|
||||
### About temporary interaction limits
|
||||
|
||||
{% tip %}
|
||||
Limiting interactions in your organization enables temporary interaction limits for all public repositories owned by the organization. {% data reusables.community.interaction-limits-restrictions %}
|
||||
|
||||
**Tip:** Organization owners can also block users for a specific amount of time. After the block expires, the user is automatically unblocked. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)."
|
||||
{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your organization's public repositories.
|
||||
|
||||
{% endtip %}
|
||||
{% data reusables.community.types-of-interaction-limits %}
|
||||
|
||||
Members of the organization are not affected by any of the limit types.
|
||||
|
||||
When you enable organization-wide activity limitations, you can't enable or disable interaction limits on individual repositories. For more information on limiting activity for an individual repository, see "[Limiting interactions in your repository](/articles/limiting-interactions-in-your-repository)."
|
||||
|
||||
Organization owners can also block users for a specific amount of time. After the block expires, the user is automatically unblocked. For more information, see "[Blocking a user from your organization](/articles/blocking-a-user-from-your-organization)."
|
||||
|
||||
### Limiting interactions in your organization
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
4. In your organization's Settings sidebar, click **Interaction limits**.
|
||||
|
||||
5. Under "Temporary interaction limits", click one or more options.
|
||||
1. In the organization settings sidebar, click **Moderation settings**.
|
||||
|
||||
1. Under "Moderation settings", click **Interaction limits**.
|
||||
|
||||
{% data reusables.community.set-interaction-limit %}
|
||||
|
||||
- **Limit to existing users**: Limits activity for organization users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators.
|
||||
- **Limit to prior contributors**: Limits activity for organization users who have not previously contributed and are not collaborators.
|
||||
- **Limit to repository collaborators**: Limits activity for organization users who do not have write access or are not collaborators.
|
||||
|
||||
### Further reading
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
|
|
|
|||
|
|
@ -1,30 +1,34 @@
|
|||
---
|
||||
title: Limiting interactions in your repository
|
||||
intro: 'People with owner or admin access can temporarily restrict certain users from commenting, opening issues, or creating pull requests in your public repository to enforce a period of limited activity.'
|
||||
intro: 'You can temporarily enforce a period of limited activity for certain users on a public repository.'
|
||||
redirect_from:
|
||||
- /articles/limiting-interactions-with-your-repository/
|
||||
- /articles/limiting-interactions-in-your-repository
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
permissions: People with admin permissions to a repository can temporarily limit interactions in that repository.
|
||||
---
|
||||
|
||||
After 24 hours, users can resume normal activity in your repository.
|
||||
### About temporary interaction limits
|
||||
|
||||
{% tip %}
|
||||
{% data reusables.community.interaction-limits-restrictions %}
|
||||
|
||||
**Tip:** Organization owners can enable organization-wide activity limitations. If organization-wide activity limitations are enabled, you can't limit activity for individual repositories. For more information, see "[Limiting interactions in your organization](/articles/limiting-interactions-in-your-organization)."
|
||||
{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your repository.
|
||||
|
||||
{% endtip %}
|
||||
{% data reusables.community.types-of-interaction-limits %}
|
||||
|
||||
You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/github/building-a-strong-community/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/github/building-a-strong-community/limiting-interactions-in-your-organization)."
|
||||
|
||||
### Limiting interactions in your repository
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
3. In your repository's Settings sidebar, click **Interaction limits**.
|
||||
|
||||
4. Under "Temporary interaction limits", click one or more options:
|
||||
1. In the left sidebar, click **Moderation settings**.
|
||||
|
||||
1. Under "Moderation settings", click **Interaction limits**.
|
||||
|
||||
{% data reusables.community.set-interaction-limit %}
|
||||
|
||||
- **Limit to existing users**: Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators.
|
||||
- **Limit to prior contributors**: Limits activity for users who have not previously contributed and are not collaborators.
|
||||
- **Limit to repository collaborators**: Limits activity for users who do not have write access or are not collaborators.
|
||||
|
||||
### Further reading
|
||||
- "[Reporting abuse or spam](/articles/reporting-abuse-or-spam)"
|
||||
|
|
|
|||
|
|
@ -61,7 +61,6 @@ You can use configuration keys supported by {% data variables.product.prodname_c
|
|||
- `settings`
|
||||
- `extensions`
|
||||
- `forwardPorts`
|
||||
- `devPort`
|
||||
- `postCreateCommand`
|
||||
|
||||
#### Docker, Dockerfile, or image settings
|
||||
|
|
@ -73,13 +72,9 @@ You can use configuration keys supported by {% data variables.product.prodname_c
|
|||
- `remoteEnv`
|
||||
- `containerUser`
|
||||
- `remoteUser`
|
||||
- `updateRemoteUserUID`
|
||||
- `mounts`
|
||||
- `workspaceMount`
|
||||
- `workspaceFolder`
|
||||
- `runArgs`
|
||||
- `overrideCommand`
|
||||
- `shutdownAction`
|
||||
- `dockerComposeFile`
|
||||
|
||||
For more information about the available settings for `devcontainer.json`, see [devcontainer.json reference](https://aka.ms/vscode-remote/devcontainer.json) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ If none of these files are found, then any files or folders in `dotfiles` starti
|
|||
|
||||
Any changes to your `dotfiles` repository will apply only to each new codespace, and do not affect any existing codespace.
|
||||
|
||||
For more information, see [Personalizing](https://docs.microsoft.com/en-us/visualstudio/online/reference/personalizing) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
For more information, see [Personalizing](https://docs.microsoft.com/visualstudio/online/reference/personalizing) in the {% data variables.product.prodname_vscode %} documentation.
|
||||
|
||||
{% note %}
|
||||
|
||||
|
|
|
|||
|
|
@ -16,10 +16,6 @@ versions:
|
|||
|
||||
{% endwarning %}
|
||||
|
||||
### Removing a file that was added in an earlier commit
|
||||
|
||||
If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)."
|
||||
|
||||
### Removing a file added in the most recent unpushed commit
|
||||
|
||||
If the file was added with your most recent commit, and you have not pushed to {% data variables.product.product_location %}, you can delete the file and amend the commit:
|
||||
|
|
@ -43,3 +39,7 @@ If the file was added with your most recent commit, and you have not pushed to {
|
|||
$ git push
|
||||
# Push our rewritten, smaller commit
|
||||
```
|
||||
|
||||
### Removing a file that was added in an earlier commit
|
||||
|
||||
If you added a file in an earlier commit, you need to remove it from the repository's history. To remove files from the repository's history, you can use the BFG Repo-Cleaner or the `git filter-branch` command. For more information see "[Removing sensitive data from a repository](/github/authenticating-to-github/removing-sensitive-data-from-a-repository)."
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ When code owners are automatically requested for review, the team is still remov
|
|||
|
||||
### Routing algorithms
|
||||
|
||||
Code review assignments automatically choose and assign reviewers based on one of two possible alogrithms.
|
||||
Code review assignments automatically choose and assign reviewers based on one of two possible algorithms.
|
||||
|
||||
The round robin algorithm chooses reviewers based on who's received the least recent review request, focusing on alternating between all members of the team regardless of the number of outstanding reviews they currently have.
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ With dependency insights you can view vulnerabilities, licenses, and other impor
|
|||
5. To view dependency insights for all your {% data variables.product.prodname_ghe_cloud %} organizations, click **My organizations**.
|
||||
|
||||
6. You can click the results in the **Open security advisories** and **Licenses** graphs to filter by a vulnerability status, a license, or a combination of the two.
|
||||
|
||||
|
||||
7. You can click on {% octicon "package" aria-label="The package icon" %} **dependents** next to each vulnerability to see which dependents in your organization are using each library.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ For more information about {% data variables.product.prodname_enterprise %}, see
|
|||
|
||||
1. After you buy {% data variables.product.prodname_vss_ghe %}, contact {% data variables.contact.contact_enterprise_sales %} and mention "{% data variables.product.prodname_vss_ghe %}." You'll work with the Sales team to create an enterprise account on {% data variables.product.prodname_dotcom_the_website %}. If you already have an enterprise account on {% data variables.product.prodname_dotcom_the_website %}, or if you're not sure, please tell our Sales team.
|
||||
|
||||
2. Assign licenses for {% data variables.product.prodname_vss_ghe %} to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. For more information about assigning licenses, see [Manage {% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/en-us/visualstudio/subscriptions/assign-github) in the Microsoft Docs.
|
||||
2. Assign licenses for {% data variables.product.prodname_vss_ghe %} to subscribers in {% data variables.product.prodname_vss_admin_portal_with_url %}. For more information about assigning licenses, see [Manage {% data variables.product.prodname_vs %} subscriptions with {% data variables.product.prodname_enterprise %}](https://docs.microsoft.com/visualstudio/subscriptions/assign-github) in the Microsoft Docs.
|
||||
|
||||
3. On {% data variables.product.prodname_dotcom_the_website %}, create at least one organization owned by your enterprise account. For more information, see "[Adding organizations to your enterprise account](/github/setting-up-and-managing-your-enterprise/adding-organizations-to-your-enterprise-account)."
|
||||
|
||||
|
|
@ -39,4 +39,4 @@ You can also see pending {% data variables.product.prodname_enterprise %} invita
|
|||
|
||||
### Further reading
|
||||
|
||||
- [Introducing Visual Studio subscriptions with GitHub Enterprise](https://docs.microsoft.com/en-us/visualstudio/subscriptions/access-github) in the Microsoft Docs
|
||||
- [Introducing Visual Studio subscriptions with GitHub Enterprise](https://docs.microsoft.com/visualstudio/subscriptions/access-github) in the Microsoft Docs
|
||||
|
|
|
|||
|
|
@ -183,6 +183,6 @@ To troubleshoot, make sure all output tags in the file in the error message are
|
|||
|
||||
This error means that your code contains an unrecognized Liquid tag.
|
||||
|
||||
To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default varibles, see "[Variables](https://jekyllrb.com/docs/variables/)" in the Jekyll documentation.
|
||||
To troubleshoot, make sure all Liquid tags in the file in the error message match Jekyll's default variables and there are no typos in the tag names. For a list of default variables, see "[Variables](https://jekyllrb.com/docs/variables/)" in the Jekyll documentation.
|
||||
|
||||
Unsupported plugins are a common source of unrecognized tags. If you use an unsupported plugin in your site by generating your site locally and pushing your static files to {% data variables.product.product_name %}, make sure the plugin is not introducing tags that are not in Jekyll's default variables. For a list of supported plugins, see "[About {% data variables.product.prodname_pages %} and Jekyll](/articles/about-github-pages-and-jekyll#plugins)."
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ You can create and manage custom teams in {% data variables.product.prodname_ins
|
|||
{% data reusables.github-insights.teams-tab %}
|
||||
{% data reusables.github-insights.edit-team %}
|
||||
3. Under "Contributors", use the drop-down menu and select a contributor.
|
||||
|
||||
|
||||
4. Click **Done**.
|
||||
|
||||
#### Removing a contributor from a custom team
|
||||
|
|
|
|||
|
|
@ -166,7 +166,7 @@ For more information, see "[Creating a personal access token](/github/authentica
|
|||
To use or manage a package hosted by a package registry, you must use a token with the appropriate scope, and your user account must have appropriate permissions for that repository.
|
||||
|
||||
For example:
|
||||
- To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permissions for the repository. If the repository is private, your token must also have the `repo` scope.
|
||||
- To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permissions for the repository.
|
||||
- To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted. For more information, see "[Deleting a package](/packages/publishing-and-managing-packages/deleting-a-package)."
|
||||
|
||||
| Scope | Description | Repository permissions |
|
||||
|
|
@ -174,7 +174,7 @@ For example:
|
|||
|`read:packages`| Download and install packages from {% data variables.product.prodname_registry %} | read |
|
||||
|`write:packages`| Upload and publish packages to {% data variables.product.prodname_registry %} | write |
|
||||
| `delete:packages` | Delete specified versions of private packages from {% data variables.product.prodname_registry %} | admin |
|
||||
| `repo` | Install, upload, and delete certain packages in private repositories (along with `read:packages`, `write:packages`, or `delete:packages`) | read, write, or admin |
|
||||
| `repo` | Upload and delete packages (along with `write:packages`, or `delete:packages`) | write, or admin |
|
||||
|
||||
When you create a {% data variables.product.prodname_actions %} workflow, you can use the `GITHUB_TOKEN` to publish and install packages in {% data variables.product.prodname_registry %} without needing to store and manage a personal access token.
|
||||
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ If your instance has subdomain isolation disabled:
|
|||
|
||||
### Publishing a package
|
||||
|
||||
You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file. When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation.
|
||||
You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file. When publishing, you need to use the same value for `OWNER` in your *csproj* file that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation.
|
||||
|
||||
{% data reusables.package_registry.viewing-packages %}
|
||||
|
||||
|
|
@ -159,7 +159,7 @@ For example, the *OctodogApp* and *OctocatApp* projects will publish to the same
|
|||
|
||||
### Installing a package
|
||||
|
||||
Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/en-us/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation.
|
||||
Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation.
|
||||
|
||||
{% data reusables.package_registry.authenticate-step %}
|
||||
|
||||
|
|
|
|||
|
|
@ -174,8 +174,8 @@ If your instance has subdomain isolation enabled:
|
|||
|
||||
```shell
|
||||
registry=https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>{% endif %}/<em>OWNER</em>
|
||||
@<em>OWNER</em>:registry={% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}
|
||||
@<em>OWNER</em>:registry={% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}
|
||||
@<em>OWNER</em>:registry=https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}
|
||||
@<em>OWNER</em>:registry=https://{% if currentVersion == "free-pro-team@latest" %}npm.pkg.github.com{% else %}npm.<em>HOSTNAME</em>/{% endif %}
|
||||
```
|
||||
|
||||
{% if enterpriseServerVersions contains currentVersion %}
|
||||
|
|
@ -183,8 +183,8 @@ If your instance has subdomain isolation disabled:
|
|||
|
||||
```shell
|
||||
registry=https://<em>HOSTNAME</em>/_registry/npm/<em>OWNER</em>
|
||||
@<em>OWNER</em>:registry=<em>HOSTNAME</em>/_registry/npm/
|
||||
@<em>OWNER</em>:registry=<em>HOSTNAME</em>/_registry/npm/
|
||||
@<em>OWNER</em>:registry=https://<em>HOSTNAME</em>/_registry/npm/
|
||||
@<em>OWNER</em>:registry=https://<em>HOSTNAME</em>/_registry/npm/
|
||||
```
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -186,7 +186,7 @@ _Branches_
|
|||
- [`POST /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/v3/repos/branches/#create-commit-signature-protection) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_signatures`](/v3/repos/branches/#delete-commit-signature-protection) (:write)
|
||||
- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#get-status-checks-protection) (:read)
|
||||
- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#update-status-check-potection) (:write)
|
||||
- [`PATCH /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#update-status-check-protection) (:write)
|
||||
- [`DELETE /repos/:owner/:repo/branches/:branch/protection/required_status_checks`](/v3/repos/branches/#remove-status-check-protection) (:write)
|
||||
- [`GET /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/v3/repos/branches/#get-all-status-check-contexts) (:read)
|
||||
- [`POST /repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts`](/v3/repos/branches/#add-status-check-contexts) (:write)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Welcome to the content style guide for [GitHub Docs](https://docs.github.com/).
|
||||
|
||||
These guidelines are specific to GitHub’s documentation. For general style questions or guidance on topics not covered here, see the [GitHub Brand Guide](https://brand.github.com/content/) first, then the [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/). For markup specific to source content on docs.github.com, see our [markup reference guide](content-markup-reference.md).
|
||||
These guidelines are specific to GitHub’s documentation. For general style questions or guidance on topics not covered here, see the [GitHub Brand Guide](https://brand.github.com/content/) first, then the [Microsoft Style Guide](https://docs.microsoft.com/style-guide/welcome/). For markup specific to source content on docs.github.com, see our [markup reference guide](content-markup-reference.md).
|
||||
|
||||
## Table of contents <!-- omit in toc -->
|
||||
- [The GitHub Docs approach to style](#the-github-docs-approach-to-style)
|
||||
|
|
@ -132,7 +132,7 @@ schedule:
|
|||
## Headers
|
||||
|
||||
Use H3 for headers, and H4 for subheaders. When referring to headers, surround the header name with quotation marks.
|
||||
- **Use:** Under “User licences”, view your total licenses.
|
||||
- **Use:** Under “User licenses”, view your total licenses.
|
||||
|
||||
To orient readers and help them understand if the section is relevant to them, include introductory content after a header - don’t locate a subheader directly following a header.
|
||||
|
||||
|
|
@ -140,7 +140,7 @@ To orient readers and help them understand if the section is relevant to them, i
|
|||
|
||||
### Alt text
|
||||
|
||||
Every image must include an alt attribute that provides a complete description of the image for the user. For more information, see “[Images, image maps, and multimedia](https://docs.microsoft.com/en-us/style-guide/accessibility/graphics-design-media#images-image-maps-and-multimedia)” in Microsoft’s Style Guide.
|
||||
Every image must include an alt attribute that provides a complete description of the image for the user. For more information, see “[Images, image maps, and multimedia](https://docs.microsoft.com/style-guide/accessibility/graphics-design-media#images-image-maps-and-multimedia)” in Microsoft’s Style Guide.
|
||||
|
||||
### Filenames
|
||||
|
||||
|
|
@ -170,9 +170,9 @@ GitHub Brand Guide:
|
|||
- [People and communities](https://brand.github.com/content/grammar#people-and-communities)
|
||||
|
||||
The Microsoft Style Guide offers resources on bias-free communication, accessibility terms, and writing for all abilities:
|
||||
- [Bias-free communication](https://docs.microsoft.com/en-us/style-guide/bias-free-communication)
|
||||
- [Writing for all abilities](https://docs.microsoft.com/en-us/style-guide/accessibility/writing-all-abilities)
|
||||
- [Accessibility terms](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms)
|
||||
- [Bias-free communication](https://docs.microsoft.com/style-guide/bias-free-communication)
|
||||
- [Writing for all abilities](https://docs.microsoft.com/style-guide/accessibility/writing-all-abilities)
|
||||
- [Accessibility terms](https://docs.microsoft.com/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms)
|
||||
|
||||
More resources for learning about inclusive and accessible language and style:
|
||||
- [18F Content Guide on Inclusive Language](https://content-guide.18f.gov/inclusive-language/)
|
||||
|
|
@ -257,7 +257,7 @@ Take care to distinguish between product names and product elements. For more in
|
|||
|
||||
## Punctuation
|
||||
|
||||
Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://brand.github.com/content/grammar#punctuation)” in GitHub’s Brand Guide and “[Punctuation](https://docs.microsoft.com/en-us/style-guide/punctuation)” in the Microsoft Style Guide.
|
||||
Follow standard American English punctuation rules. For more guidance, see “[Punctuation](https://brand.github.com/content/grammar#punctuation)” in GitHub’s Brand Guide and “[Punctuation](https://docs.microsoft.com/style-guide/punctuation)” in the Microsoft Style Guide.
|
||||
|
||||
## Reusables and variables
|
||||
Use reusable strings for individual nouns (e.g. product names) or for complete sentences or paragraphs. Sentence fragments and phrases should not be contained in reusable strings as they can cause problems when content is localized. For more information, see the data directory in the github/docs repository and the “Product names” section of this document.
|
||||
|
|
@ -272,7 +272,7 @@ A table’s contents should be clear from the preceding content - avoid unneeded
|
|||
|
||||
Use quotation marks around article titles, whether the article is hosted on GitHub Docs or elsewhere. Do not include quotation marks around the names of external sites.
|
||||
|
||||
For further guidance, see “[Formatting titles](https://docs.microsoft.com/en-us/style-guide/text-formatting/formatting-titles)” in Microsoft’s Style Guide.
|
||||
For further guidance, see “[Formatting titles](https://docs.microsoft.com/style-guide/text-formatting/formatting-titles)” in Microsoft’s Style Guide.
|
||||
|
||||
## User interface elements
|
||||
|
||||
|
|
@ -338,15 +338,15 @@ GitHub Brand Guide:
|
|||
- [Referring to GitHub features and product elements](https://brand.github.com/content/terminology/#referring-to-github-features-and-product-elements)
|
||||
- [Page names and UI references](https://brand.github.com/content/grammar#page-names-and-ui-references)
|
||||
Microsoft Style Guide:
|
||||
- [Formatting text in instructions](https://docs.microsoft.com/en-us/style-guide/procedures-instructions/formatting-text-in-instructions)
|
||||
- [Formatting text in instructions](https://docs.microsoft.com/style-guide/procedures-instructions/formatting-text-in-instructions)
|
||||
|
||||
## Voice and tone
|
||||
|
||||
Use clear, simple language that’s approachable and accessible for a wide range of readers. For more information, see “[Voice](https://brand.github.com/content/voice)” in GitHub’s Brand Guide. To learn more about writing approachable content, see “[Microsoft's brand voice: Above all, simple and human](https://docs.microsoft.com/en-us/style-guide/brand-voice-above-all-simple-human) and “[Top 10 tips for Microsoft style and voice](https://docs.microsoft.com/en-us/style-guide/top-10-tips-style-voice).”
|
||||
Use clear, simple language that’s approachable and accessible for a wide range of readers. For more information, see “[Voice](https://brand.github.com/content/voice)” in GitHub’s Brand Guide. To learn more about writing approachable content, see “[Microsoft's brand voice: Above all, simple and human](https://docs.microsoft.com/style-guide/brand-voice-above-all-simple-human) and “[Top 10 tips for Microsoft style and voice](https://docs.microsoft.com/style-guide/top-10-tips-style-voice).”
|
||||
|
||||
## Word choice and terminology
|
||||
|
||||
For general guidance and GitHub-specific terms, see “[Terminology](https://brand.github.com/content/terminology)” and “[Words that can be tricky](https://brand.github.com/content/grammar#words-that-can-be-tricky)” in GitHub’s Brand Guide. For more detailed guidance, see the “[A-Z word list](https://docs.microsoft.com/en-us/style-guide)” in Microsoft’s style guide.
|
||||
For general guidance and GitHub-specific terms, see “[Terminology](https://brand.github.com/content/terminology)” and “[Words that can be tricky](https://brand.github.com/content/grammar#words-that-can-be-tricky)” in GitHub’s Brand Guide. For more detailed guidance, see the “[A-Z word list](https://docs.microsoft.com/style-guide)” in Microsoft’s style guide.
|
||||
|
||||
### Abbreviations
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Node Versions
|
||||
|
||||
In [development](contributing/development.md) enviroments this site will run on Node.js versions `12 - 14`.
|
||||
In [development](contributing/development.md) environments this site will run on Node.js versions `12 - 14`.
|
||||
|
||||
In [staging and production](contributing/deployments.md) environments this site runs on Node.js 14, the [Active LTS version](https://nodejs.org/en/about/releases/) from 2020-10-27 to 2021-10-26).
|
||||
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ Again, you should see more information about the error either in your browser or
|
|||
|
||||
The `check internal links` test reports any broken links on the site, including images. The test reports the URL of the broken link, _not_ the file that includes that link, so you'll need to search the `docs` repository to find the file.
|
||||
|
||||
Broken images include `assets/images/` in the URL and are often caused by images being versioned for previous versions of GHES but not uploaded to the appropriate folder in S3. Search the `docs` repository for the file name (e.g., `assets/images/help/repository/security-tab.png`), then make sure the image is versioned correctly in each result. If the image is in a reusable, you'll also need to search for each occurence of that reusable. If the image is versioned correctly, upload the image to the appropriate folder(s) in S3.
|
||||
Broken images include `assets/images/` in the URL and are often caused by images being versioned for previous versions of GHES but not uploaded to the appropriate folder in S3. Search the `docs` repository for the file name (e.g., `assets/images/help/repository/security-tab.png`), then make sure the image is versioned correctly in each result. If the image is in a reusable, you'll also need to search for each occurrence of that reusable. If the image is versioned correctly, upload the image to the appropriate folder(s) in S3.
|
||||
|
||||
For broken links to articles on our site, find the file that contains the link by searching the `docs` repository for the file name (e.g., `incorporating-feedback-in-your-pull-request`). Try the following fixes:
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1 @@
|
|||
When you enable an interaction limit, you can choose a duration for the limit: 24 hours, 3 days, 1 week, 1 month, or 6 months.
|
||||
|
|
@ -0,0 +1 @@
|
|||
Enabling an interaction limit for a repository restricts certain users from commenting, opening issues, creating pull requests, reacting with emojis, editing existing comments, and editing titles of issues and pull requests.
|
||||
|
|
@ -0,0 +1 @@
|
|||
5. Under "Temporary interaction limits", to the right of the type of interaction limit you want to set, use the **Enable** drop-down menu, then click the duration you want for your interaction limit.
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
There are three types of interaction limits.
|
||||
- **Limit to existing users**: Limits activity for users with accounts that are less than 24 hours old who do not have prior contributions and are not collaborators.
|
||||
- **Limit to prior contributors**: Limits activity for users who have not previously contributed to the default branch of the repository and are not collaborators.
|
||||
- **Limit to repository collaborators**: Limits activity for users who do not have write access to the repository.
|
||||
|
|
@ -1,2 +1,2 @@
|
|||
1. Under **{% octicon "gear" aria-label="The gear icon" %} Settings**, click **Contibutors**.
|
||||
1. Under **{% octicon "gear" aria-label="The gear icon" %} Settings**, click **Contributors**.
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Canceling an app or downgrading an app to free does not affect your [other paid subcriptions](/articles/about-billing-on-github) on {% data variables.product.prodname_dotcom %}. If you want to cease all of your paid subscriptions on {% data variables.product.prodname_dotcom %}, you must downgrade each paid subscription separately.
|
||||
Canceling an app or downgrading an app to free does not affect your [other paid subscriptions](/articles/about-billing-on-github) on {% data variables.product.prodname_dotcom %}. If you want to cease all of your paid subscriptions on {% data variables.product.prodname_dotcom %}, you must downgrade each paid subscription separately.
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
When you close a project board, any workflow automation configured for the project board will pause. If you reopen a project board, you have the option to sync automation, which updates the positon of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[Closing a project board](/articles/closing-a-project-board)."
|
||||
When you close a project board, any workflow automation configured for the project board will pause. If you reopen a project board, you have the option to sync automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[Reopening a closed project board](/articles/reopening-a-closed-project-board)" or "[Closing a project board](/articles/closing-a-project-board)."
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Key | Type | Description
|
||||
----|------|------------
|
||||
`action` | `string` | The action that was performed. Can be one of:<ul><li>`created` - Someone installs a {% data variables.product.prodname_github_app %}.</li><li>`deleted` - Someone uninstalls a {% data variables.product.prodname_github_app %}</li>{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.20" or currentVersion == "github-ae@latest" %}<li>`suspend` - Someone suspends a {% data variables.product.prodname_github_app %} installation.</li><li>`unsuspend` - Someone unsuspends a {% data variables.product.prodname_github_app %} installation.</li>{% endif %}<li>`new_permissions_accepted` - Someone accepts new permissions for a {% data variables.product.prodname_github_app %} installation. When a {% data variables.product.prodname_github_app %} owner requests new permissions, the person who installed the {% data variables.product.prodname_github_app %} must accept the new permissions request. </li></ul>
|
||||
`repositories` | `array` | An array of repository objects that the insatllation can access.
|
||||
`repositories` | `array` | An array of repository objects that the installation can access.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
Key | Type | Description
|
||||
----|------|-------------
|
||||
`action`|`string` | The action that was performed. Can be one of:<ul><li> `added` - A user accepts an invitation to a repository.</li><li>`removed` - A user is removed as a collaborator in a repository.</li><li>`edited` - A user's collaborator permissios have changed. </li></ul>
|
||||
`action`|`string` | The action that was performed. Can be one of:<ul><li> `added` - A user accepts an invitation to a repository.</li><li>`removed` - A user is removed as a collaborator in a repository.</li><li>`edited` - A user's collaborator permissions have changed. </li></ul>
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isnt stored so it isn't retrievable via the [Events API](/rest/reference/activity#ping-a-repository-webhook) endpoint.
|
||||
When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the [Events API](/rest/reference/activity#ping-a-repository-webhook) endpoint.
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
`repository` | `object` | The [`repository`](/v3/repos/#get-a-repository) where the event occured.
|
||||
`repository` | `object` | The [`repository`](/v3/repos/#get-a-repository) where the event occurred.
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Activity related to security vulnerability alerts in a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[About security alerts for vulerable dependencies](/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies)".
|
||||
Activity related to security vulnerability alerts in a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[About security alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-security-alerts-for-vulnerable-dependencies)".
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ nested:
|
|||
too: Yes!
|
||||
```
|
||||
|
||||
Its values would be accesible as:
|
||||
Its values would be accessible as:
|
||||
|
||||
```
|
||||
{% data foo.bar.meaning_of_life %}
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@
|
|||
|
||||
<!-- GitHub.com homepage and 404 page has a stylized search; Enterprise homepages do not -->
|
||||
{% if page.relativePath != 'index.md' and error != '404' %}
|
||||
<div class="pt-3 pt-md-0 d-md-inline-block ml-md-3 bord'er-top border-md-top-0">
|
||||
<div class="pt-3 pt-md-0 d-md-inline-block ml-md-3 border-top border-md-top-0">
|
||||
{% include search-form %}
|
||||
<div id="search-results-container"></div>
|
||||
<div class="search-overlay-desktop"></div>
|
||||
|
|
|
|||
|
|
@ -88,11 +88,11 @@
|
|||
"deprecationDate": "2021-06-09"
|
||||
},
|
||||
"2.22": {
|
||||
"releaseDate": "2020-09-08",
|
||||
"deprecationDate": "2021-09-08"
|
||||
"releaseDate": "2020-09-23",
|
||||
"deprecationDate": "2021-09-23"
|
||||
},
|
||||
"2.23": {
|
||||
"releaseDate": "2020-11-10",
|
||||
"deprecationDate": "2021-11-10"
|
||||
"3.0": {
|
||||
"releaseDate": "2020-12-08",
|
||||
"deprecationDate": "2021-12-08"
|
||||
}
|
||||
}
|
||||
|
|
@ -354,7 +354,7 @@ describe('server', () => {
|
|||
|
||||
test('articles that link to external links that contain /articles/ are not rewritten', async () => {
|
||||
const $ = await getDOM(`${latestEnterprisePath}/admin/installation/upgrading-github-enterprise-server`)
|
||||
expect($('article a[href="https://azure.microsoft.com/en-us/documentation/articles/backup-azure-vms/"]').length).toBe(1)
|
||||
expect($('article a[href="https://docs.microsoft.com/azure/backup/backup-azure-vms-first-look-arm"]').length).toBe(1)
|
||||
})
|
||||
})
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче