Octomerger Bot
15
translations/es-ES/content/actions/examples/index.md
Normal file
15
translations/es-ES/content/actions/examples/index.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Ejemplos
|
||||
shortTitle: Ejemplos
|
||||
intro: 'Example workflows that demonstrate the CI/CD features of {% data variables.product.prodname_actions %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- using-scripts-to-test-your-code-on-a-runner
|
||||
- using-the-github-cli-on-a-runner
|
||||
- using-concurrency-expressions-and-a-test-matrix
|
||||
---
|
||||
|
||||
@@ -0,0 +1,658 @@
|
||||
---
|
||||
title: 'Using concurrency, expressions, and a test matrix'
|
||||
shortTitle: 'Using concurrency, expressions, and a test matrix'
|
||||
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>= 3.5'
|
||||
ghae: issue-4925
|
||||
ghec: '*'
|
||||
showMiniToc: false
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
- [Example overview](#example-overview)
|
||||
- [Features used in this example](#features-used-in-this-example)
|
||||
- [Ejemplo de flujo de trabajo](#example-workflow)
|
||||
- [Understanding the example](#understanding-the-example)
|
||||
- [Pasos siguientes](#next-steps)
|
||||
|
||||
## Example overview
|
||||
|
||||
{% data reusables.actions.example-workflow-intro-ci %} When this workflow is triggered, it tests your code using a matrix of test combinations with `npm test`.
|
||||
|
||||
{% data reusables.actions.example-diagram-intro %}
|
||||
|
||||
|
||||
|
||||
## Features used in this example
|
||||
|
||||
{% data reusables.actions.example-table-intro %}
|
||||
|
||||
| **Característica** | **Implementación** |
|
||||
| ------------------ | ------------------ |
|
||||
| | |
|
||||
{% data reusables.actions.workflow-dispatch-table-entry %}
|
||||
{% data reusables.actions.pull-request-table-entry %}
|
||||
{% data reusables.actions.cron-table-entry %}
|
||||
{% data reusables.actions.permissions-table-entry %}
|
||||
{% data reusables.actions.concurrency-table-entry %}
|
||||
| Running the job on different runners, depending on the repository: | [`runs-on`](/actions/using-jobs/choosing-the-runner-for-a-job)|
|
||||
{% data reusables.actions.if-conditions-table-entry %}
|
||||
| Using a matrix to create different test configurations: | [`matrix`](/actions/using-jobs/using-a-build-matrix-for-your-jobs)|
|
||||
{% data reusables.actions.checkout-action-table-entry %}
|
||||
{% data reusables.actions.setup-node-table-entry %}
|
||||
| Caching dependencies: | [`actions/cache`](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows)| | Running tests on the runner: | `npm test`|
|
||||
|
||||
## Ejemplo de flujo de trabajo
|
||||
|
||||
{% data reusables.actions.example-docs-engineering-intro %} [`test.yml`](https://github.com/github/docs/blob/main/.github/workflows/test.yml).
|
||||
|
||||
{% data reusables.actions.note-understanding-example %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:100%"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Node.js Tests
|
||||
|
||||
# **What it does**: Runs our tests.
|
||||
# **Why we have it**: We want our tests to pass before merging code.
|
||||
# **Who does it impact**: Docs engineering, open-source engineering contributors.
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- gh-readonly-queue/main/**
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
# Needed for the 'trilom/file-changes-action' action
|
||||
pull-requests: read
|
||||
|
||||
# This allows a subsequently queued workflow run to interrupt previous runs
|
||||
concurrency:
|
||||
group: {% raw %}'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'{% endraw %}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
test:
|
||||
# Run on self-hosted if the private repo or ubuntu-latest if the public repo
|
||||
# See pull # 17442 in the private repo for context
|
||||
runs-on: {% raw %}${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}{% endraw %}
|
||||
timeout-minutes: 60
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
# The same array lives in test-windows.yml, so make any updates there too.
|
||||
test-group:
|
||||
[
|
||||
content,
|
||||
graphql,
|
||||
meta,
|
||||
rendering,
|
||||
routing,
|
||||
unit,
|
||||
linting,
|
||||
translations,
|
||||
]
|
||||
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
|
||||
- name: Check out repo
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
# Not all test suites need the LFS files. So instead, we opt to
|
||||
# NOT clone them initially and instead, include them manually
|
||||
# only for the test groups that we know need the files.
|
||||
lfs: {% raw %}${{ matrix.test-group == 'content' }}{% endraw %}
|
||||
# Enables cloning the Early Access repo later with the relevant PAT
|
||||
persist-credentials: 'false'
|
||||
|
||||
- name: Figure out which docs-early-access branch to checkout, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
id: check-early-access
|
||||
uses: {% data reusables.actions.action-github-script %}
|
||||
env:
|
||||
BRANCH_NAME: {% raw %}${{ github.head_ref || github.ref_name }}{% endraw %}
|
||||
with:
|
||||
github-token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
result-encoding: string
|
||||
script: |
|
||||
// If being run from a PR, this becomes 'my-cool-branch'.
|
||||
// If run on main, with the `workflow_dispatch` action for
|
||||
// example, the value becomes 'main'.
|
||||
const { BRANCH_NAME } = process.env
|
||||
try {
|
||||
const response = await github.repos.getBranch({
|
||||
owner: 'github',
|
||||
repo: 'docs-early-access',
|
||||
BRANCH_NAME,
|
||||
})
|
||||
console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`)
|
||||
return BRANCH_NAME
|
||||
} catch (err) {
|
||||
if (err.status === 404) {
|
||||
console.log(`There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`)
|
||||
return 'main'
|
||||
}
|
||||
throw err
|
||||
}
|
||||
|
||||
- name: Check out docs-early-access too, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
repository: github/docs-early-access
|
||||
token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
path: docs-early-access
|
||||
ref: {% raw %}${{ steps.check-early-access.outputs.result }}{% endraw %}
|
||||
|
||||
- name: Merge docs-early-access repo's folders
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
run: |
|
||||
mv docs-early-access/assets assets/images/early-access
|
||||
mv docs-early-access/content content/early-access
|
||||
mv docs-early-access/data data/early-access
|
||||
rm -r docs-early-access
|
||||
|
||||
# This is necessary when LFS files where cloned but does nothing
|
||||
# if actions/checkout was run with `lfs:false`.
|
||||
- name: Checkout LFS objects
|
||||
run: git lfs checkout
|
||||
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
id: get_diff_files
|
||||
with:
|
||||
# So that `steps.get_diff_files.outputs.files` becomes
|
||||
# a string like `foo.js path/bar.md`
|
||||
output: ' '
|
||||
|
||||
- name: Insight into changed files
|
||||
run: |
|
||||
|
||||
# Must to do this because the list of files can be HUGE. Especially
|
||||
# in a repo-sync when there are lots of translation files involved.
|
||||
echo {% raw %}"${{ steps.get_diff_files.outputs.files }}" > get_diff_files.txt{% endraw %}
|
||||
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.14.x
|
||||
cache: npm
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Cache nextjs build
|
||||
uses: {% data reusables.actions.action-cache %}
|
||||
with:
|
||||
path: .next/cache
|
||||
key: {% raw %}${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}{% endraw %}
|
||||
|
||||
- name: Run build script
|
||||
run: npm run build
|
||||
|
||||
- name: Run tests
|
||||
env:
|
||||
DIFF_FILE: get_diff_files.txt
|
||||
CHANGELOG_CACHE_FILE_PATH: tests/fixtures/changelog-feed.json
|
||||
run: npm test -- {% raw %}tests/${{ matrix.test-group }}/{% endraw %}
|
||||
```
|
||||
</tr>
|
||||
</td>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Understanding the example
|
||||
|
||||
{% data reusables.actions.example-explanation-table-intro %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:60%"><b>Código</b></th>
|
||||
<th style="width:40%"><b>Explanation</b></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Node.js Tests
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
{% data reusables.actions.explanation-name-key %}
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
on:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `on` keyword lets you define the events that trigger when the workflow is run. You can define multiple events here. For more information, see "[Triggering a workflow](/actions/using-workflows/triggering-a-workflow#using-events-to-trigger-workflows)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
workflow_dispatch:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `workflow_dispatch` event if you want to be able to manually run this workflow in the UI. For more information, see [`workflow_dispatch`](/actions/reference/events-that-trigger-workflows#workflow_dispatch).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
pull_request:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `pull_request` event, so that the workflow runs automatically every time a pull request is created or updated. For more information, see [`pull_request`](/actions/using-workflows/events-that-trigger-workflows#pull_request).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
push:
|
||||
branches:
|
||||
- gh-readonly-queue/main/**
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `push` event, so that the workflow runs automatically every time a commit is pushed to a branch matching the filter `gh-readonly-queue/main/**`. For more information, see [`push`](/actions/using-workflows/events-that-trigger-workflows#push).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Modifies the default permissions granted to `GITHUB_TOKEN`. This will vary depending on the needs of your workflow. For more information, see "[Assigning permissions to jobs](/actions/using-jobs/assigning-permissions-to-jobs)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
|
||||
```yaml{:copy}
|
||||
concurrency:
|
||||
group: {% raw %}'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates a concurrency group for specific events, and uses the `||` operator to define fallback values. For more information, see "[Using concurrency](/actions/using-jobs/using-concurrency)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
cancel-in-progress: true
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Cancels any currently running job or workflow in the same concurrency group.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
jobs:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the jobs that run in the workflow file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
test:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines a job with the ID `test` that is stored within the `jobs` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
runs-on: {% raw %}${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Configures the job to run on a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner, depending on the repository running the workflow. In this example, the job will run on a self-hosted runner if the repository is named `docs-internal` and is within the `github` organization. If the repository doesn't match this path, then it will run on an `ubuntu-latest` runner hosted by {% data variables.product.prodname_dotcom %}. For more information on these options see "[Choosing the runner for a job](/actions/using-jobs/choosing-the-runner-for-a-job)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
timeout-minutes: 60
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Sets the maximum number of minutes to let the job run before it is automatically canceled. For more information, see [`timeout-minutes`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
strategy:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
This section defines the build matrix for your jobs.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
fail-fast: false
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Setting `fail-fast` to `false` prevents {% data variables.product.prodname_dotcom %} from cancelling all in-progress jobs if any matrix job fails.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
matrix:
|
||||
test-group:
|
||||
[
|
||||
content,
|
||||
graphql,
|
||||
meta,
|
||||
rendering,
|
||||
routing,
|
||||
unit,
|
||||
linting,
|
||||
translations,
|
||||
]
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates a matrix named `test-group`, with an array of test groups. These values match the names of test groups that will be run by `npm test`.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
steps:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the steps that will run as part of the `test` job. Each job in a workflow has its own `steps` section.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Check out repo
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
lfs: {% raw %}${{ matrix.test-group == 'content' }}{% endraw %}
|
||||
persist-credentials: 'false'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `uses` keyword tells the job to retrieve the action named `actions/checkout`. Esta es una acción que revisa tu repositorio y lo descarga al ejecutor, lo que te permite ejecutar acciones contra tu código (tales como las herramientas de prueba). Debes utilizar la acción de verificación cada que tu flujo de trabajo se ejecute contra el código del repositorio o cada que estés utilizando una acción definida en el repositorio. Some extra options are provided to the action using the `with` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Figure out which docs-early-access branch to checkout, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
id: check-early-access
|
||||
uses: {% data reusables.actions.action-github-script %}
|
||||
env:
|
||||
BRANCH_NAME: {% raw %}${{ github.head_ref || github.ref_name }}{% endraw %}
|
||||
with:
|
||||
github-token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
result-encoding: string
|
||||
script: |
|
||||
// If being run from a PR, this becomes 'my-cool-branch'.
|
||||
// If run on main, with the `workflow_dispatch` action for
|
||||
// example, the value becomes 'main'.
|
||||
const { BRANCH_NAME } = process.env
|
||||
try {
|
||||
const response = await github.repos.getBranch({
|
||||
owner: 'github',
|
||||
repo: 'docs-early-access',
|
||||
BRANCH_NAME,
|
||||
})
|
||||
console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`)
|
||||
return BRANCH_NAME
|
||||
} catch (err) {
|
||||
if (err.status === 404) {
|
||||
console.log(`There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`)
|
||||
return 'main'
|
||||
}
|
||||
throw err
|
||||
}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the current repository is the `github/docs-internal` repository, this step uses the `actions/github-script` action to run a script to check if there is a branch called `docs-early-access`.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Check out docs-early-access too, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
repository: github/docs-early-access
|
||||
token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
path: docs-early-access
|
||||
ref: {% raw %}${{ steps.check-early-access.outputs.result }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the current repository is the `github/docs-internal` repository, this step checks out the branch from the `github/docs-early-access` that was identified in the previous step.
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Merge docs-early-access repo's folders
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
run: |
|
||||
mv docs-early-access/assets assets/images/early-access
|
||||
mv docs-early-access/content content/early-access
|
||||
mv docs-early-access/data data/early-access
|
||||
rm -r docs-early-access
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the current repository is the `github/docs-internal` repository, this step uses the `run` keyword to execute shell commands to move the `docs-early-access` repository's folders into the main repository's folders.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Checkout LFS objects
|
||||
run: git lfs checkout
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs a command to check out LFS objects from the repository.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
id: get_diff_files
|
||||
with:
|
||||
# So that `steps.get_diff_files.outputs.files` becomes
|
||||
# a string like `foo.js path/bar.md`
|
||||
output: ' '
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `trilom/file-changes-action` action to gather the files changed in the pull request, so they can be analyzed in the next step. This example is pinned to a specific version of the action, using the `a6ca26c14274c33b15e6499323aac178af06ad4b` SHA.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Insight into changed files
|
||||
run: |
|
||||
echo {% raw %}"${{ steps.get_diff_files.outputs.files }}" > get_diff_files.txt{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs a shell command that uses an output from the previous step to create a file containing the list of files changed in the pull request.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.14.x
|
||||
cache: npm
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/setup-node` action to install the specified version of the `node` software package on the runner, which gives you access to the `npm` command.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs the `npm ci` shell command to install the npm software packages for the project.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Cache nextjs build
|
||||
uses: {% data reusables.actions.action-cache %}
|
||||
with:
|
||||
path: .next/cache
|
||||
key: {% raw %}${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/cache` action to cache the Next.js build, so that the workflow will attempt to retrieve a cache of the build, and not rebuild it from scratch every time. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run build script
|
||||
run: npm run build
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs the build script.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run tests
|
||||
env:
|
||||
DIFF_FILE: get_diff_files.txt
|
||||
CHANGELOG_CACHE_FILE_PATH: tests/fixtures/changelog-feed.json
|
||||
run: npm test -- {% raw %}tests/${{ matrix.test-group }}/{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs the tests using `npm test`, and the test matrix provides a different value for {% raw %}`${{ matrix.test-group }}`{% endraw %} for each job in the matrix. It uses the `DIFF_FILE` environment variable to know which files have changed, and uses the `CHANGELOG_CACHE_FILE_PATH` environment variable for the changelog cache file.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Pasos siguientes
|
||||
|
||||
{% data reusables.actions.learning-actions %}
|
||||
@@ -0,0 +1,421 @@
|
||||
---
|
||||
title: Using scripts to test your code on a runner
|
||||
shortTitle: Using scripts to test your code on a runner
|
||||
intro: 'How to use essential {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '> 3.1'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
showMiniToc: false
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
- [Example overview](#example-overview)
|
||||
- [Features used in this example](#features-used-in-this-example)
|
||||
- [Ejemplo de flujo de trabajo](#example-workflow)
|
||||
- [Understanding the example](#understanding-the-example)
|
||||
- [Pasos siguientes](#next-steps)
|
||||
|
||||
## Example overview
|
||||
|
||||
{% data reusables.actions.example-workflow-intro-ci %} When this workflow is triggered, it automatically runs a script that checks whether the {% data variables.product.prodname_dotcom %} Docs site has any broken links.
|
||||
|
||||
{% data reusables.actions.example-diagram-intro %}
|
||||
|
||||
|
||||
|
||||
## Features used in this example
|
||||
|
||||
{% data reusables.actions.example-table-intro %}
|
||||
|
||||
| **Característica** | **Implementación** |
|
||||
| ------------------ | ------------------ |
|
||||
| | |
|
||||
{% data reusables.actions.push-table-entry %}
|
||||
{% data reusables.actions.pull-request-table-entry %}
|
||||
{% data reusables.actions.workflow-dispatch-table-entry %}
|
||||
{% data reusables.actions.permissions-table-entry %}
|
||||
{% data reusables.actions.concurrency-table-entry %}
|
||||
| Running the job on different runners, depending on the repository: | [`runs-on`](/actions/using-jobs/choosing-the-runner-for-a-job)|
|
||||
{% data reusables.actions.checkout-action-table-entry %}
|
||||
{% data reusables.actions.setup-node-table-entry %}
|
||||
| Using a third-party action: | [`trilom/file-changes-action`](https://github.com/trilom/file-changes-action)| | Running a script on the runner: | Using `./script/rendered-content-link-checker.mjs` |
|
||||
|
||||
## Ejemplo de flujo de trabajo
|
||||
|
||||
{% data reusables.actions.example-docs-engineering-intro %} [`link-check-all.yml`](https://github.com/github/docs/blob/main/.github/workflows/link-check-all.yml).
|
||||
|
||||
{% data reusables.actions.note-understanding-example %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:100%"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: 'Link Checker: All English'
|
||||
|
||||
# **What it does**: Renders the content of every page and check all internal links.
|
||||
# **Why we have it**: To make sure all links connect correctly.
|
||||
# **Who does it impact**: Docs content.
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
# Needed for the 'trilom/file-changes-action' action
|
||||
pull-requests: read
|
||||
|
||||
# This allows a subsequently queued workflow run to interrupt previous runs
|
||||
concurrency:
|
||||
group: {% raw %}'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'{% endraw %}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
check-links:
|
||||
runs-on: {% raw %}${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}{% endraw %}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.13.x
|
||||
cache: npm
|
||||
|
||||
- name: Install
|
||||
run: npm ci
|
||||
|
||||
# Creates file "${{ env.HOME }}/files.json", among others
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
with:
|
||||
fileOutput: 'json'
|
||||
|
||||
# For verification
|
||||
- name: Show files changed
|
||||
run: cat $HOME/files.json
|
||||
|
||||
- name: Link check (warnings, changed files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--max 100 \
|
||||
--check-anchors \
|
||||
--check-images \
|
||||
--verbose \
|
||||
--list $HOME/files.json
|
||||
|
||||
- name: Link check (critical, all files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--exit \
|
||||
--verbose \
|
||||
--check-images \
|
||||
--level critical
|
||||
```
|
||||
</tr>
|
||||
</td>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Understanding the example
|
||||
|
||||
{% data reusables.actions.example-explanation-table-intro %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:60%"><b>Código</b></th>
|
||||
<th style="width:40%"><b>Explanation</b></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: 'Link Checker: All English'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
{% data reusables.actions.explanation-name-key %}
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
on:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `on` keyword lets you define the events that trigger when the workflow is run. You can define multiple events here. For more information, see "[Triggering a workflow](/actions/using-workflows/triggering-a-workflow#using-events-to-trigger-workflows)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
workflow_dispatch:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `workflow_dispatch` event if you want to be able to manually run this workflow from the UI. For more information, see [`workflow_dispatch`](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `push` event, so that the workflow runs automatically every time a commit is pushed to a branch called `main`. For more information, see [`push`](/actions/using-workflows/events-that-trigger-workflows#push).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
pull_request:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `pull_request` event, so that the workflow runs automatically every time a pull request is created or updated. For more information, see [`pull_request`](/actions/using-workflows/events-that-trigger-workflows#pull_request).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Modifies the default permissions granted to `GITHUB_TOKEN`. This will vary depending on the needs of your workflow. For more information, see "[Assigning permissions to jobs](/actions/using-jobs/assigning-permissions-to-jobs)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
concurrency:
|
||||
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
|
||||
```
|
||||
{% endraw %}
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates a concurrency group for specific events, and uses the `||` operator to define fallback values. For more information, see "[Using concurrency](/actions/using-jobs/using-concurrency)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
cancel-in-progress: true
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Cancels any currently running job or workflow in the same concurrency group.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
jobs:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the jobs that run in the workflow file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
check-links:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines a job with the ID `check-links` that is stored within the `jobs` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
|
||||
```
|
||||
{% endraw %}
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Configures the job to run on a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner, depending on the repository running the workflow. In this example, the job will run on a self-hosted runner if the repository is named `docs-internal` and is within the `github` organization. If the repository doesn't match this path, then it will run on an `ubuntu-latest` runner hosted by {% data variables.product.prodname_dotcom %}. For more information on these options see "[Choosing the runner for a job](/actions/using-jobs/choosing-the-runner-for-a-job)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
steps:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the steps that will run as part of the `check-links` job. Each job in a workflow has its own `steps` section.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Checkout
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `uses` keyword tells the job to retrieve the action named `actions/checkout`. Esta es una acción que revisa tu repositorio y lo descarga al ejecutor, lo que te permite ejecutar acciones contra tu código (tales como las herramientas de prueba). Debes utilizar la acción de verificación cada que tu flujo de trabajo se ejecute contra el código del repositorio o cada que estés utilizando una acción definida en el repositorio.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.13.x
|
||||
cache: npm
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/setup-node` action to install the specified version of the Node.js software package on the runner, which gives you access to the `npm` command.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Install
|
||||
run: npm ci
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `run` keyword tells the job to execute a command on the runner. In this case, `npm ci` is used to install the npm software packages for the project.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
with:
|
||||
fileOutput: 'json'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Uses the `trilom/file-changes-action` action to gather all the changed files. This example is pinned to a specific version of the action, using the `a6ca26c14274c33b15e6499323aac178af06ad4b` SHA.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Show files changed
|
||||
run: cat $HOME/files.json
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Lists the contents of `files.json`. This will be visible in the workflow run's log, and can be useful for debugging.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Link check (warnings, changed files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--max 100 \
|
||||
--check-anchors \
|
||||
--check-images \
|
||||
--verbose \
|
||||
--list $HOME/files.json
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses `run` command to execute a script that is stored in the repository at `script/rendered-content-link-checker.mjs` and passes all the parameters it needs to run.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Link check (critical, all files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--exit \
|
||||
--verbose \
|
||||
--check-images \
|
||||
--level critical
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step also uses `run` command to execute a script that is stored in the repository at `script/rendered-content-link-checker.mjs` and passes a different set of parameters.
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Pasos siguientes
|
||||
|
||||
{% data reusables.actions.learning-actions %}
|
||||
@@ -0,0 +1,486 @@
|
||||
---
|
||||
title: Using the GitHub CLI on a runner
|
||||
shortTitle: Using the GitHub CLI on a runner
|
||||
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '> 3.1'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
showMiniToc: false
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
- [Example overview](#example-overview)
|
||||
- [Features used in this example](#features-used-in-this-example)
|
||||
- [Ejemplo de flujo de trabajo](#example-workflow)
|
||||
- [Understanding the example](#understanding-the-example)
|
||||
- [Pasos siguientes](#next-steps)
|
||||
|
||||
## Example overview
|
||||
|
||||
{% data reusables.actions.example-workflow-intro-ci %} When this workflow is triggered, it automatically runs a script that checks whether the {% data variables.product.prodname_dotcom %} Docs site has any broken links. If any broken links are found, the workflow uses the {% data variables.product.prodname_dotcom %} CLI to create a {% data variables.product.prodname_dotcom %} issue with the details.
|
||||
|
||||
{% data reusables.actions.example-diagram-intro %}
|
||||
|
||||
|
||||
|
||||
## Features used in this example
|
||||
|
||||
{% data reusables.actions.example-table-intro %}
|
||||
|
||||
| **Característica** | **Implementación** |
|
||||
| ------------------ | ------------------ |
|
||||
| | |
|
||||
{% data reusables.actions.cron-table-entry %}
|
||||
{% data reusables.actions.permissions-table-entry %}
|
||||
{% data reusables.actions.if-conditions-table-entry %}
|
||||
{% data reusables.actions.secrets-table-entry %}
|
||||
{% data reusables.actions.checkout-action-table-entry %}
|
||||
{% data reusables.actions.setup-node-table-entry %}
|
||||
| Using a third-party action: | [`peter-evans/create-issue-from-file`](https://github.com/peter-evans/create-issue-from-file)| | Running shell commands on the runner: | [`run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun) | | Running a script on the runner: | Using `script/check-english-links.js` | | Generating an output file: | Piping the output using the `>` operator | | Checking for existing issues using {% data variables.product.prodname_cli %}: | [`gh issue list`](https://cli.github.com/manual/gh_issue_list) | | Commenting on an issue using {% data variables.product.prodname_cli %}: | [`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) |
|
||||
|
||||
## Ejemplo de flujo de trabajo
|
||||
|
||||
{% data reusables.actions.example-docs-engineering-intro %} [`check-all-english-links.yml`](https://github.com/github/docs/blob/main/.github/workflows/check-all-english-links.yml).
|
||||
|
||||
{% data reusables.actions.note-understanding-example %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:70%"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Check all English links
|
||||
|
||||
# **What it does**: This script once a day checks all English links and reports in issues.
|
||||
# **Why we have it**: We want to know if any links break.
|
||||
# **Who does it impact**: Docs content.
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '40 19 * * *' # once a day at 19:40 UTC / 11:40 PST
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
check_all_english_links:
|
||||
name: Check all links
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
GITHUB_TOKEN: {% raw %}${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}{% endraw %}
|
||||
FIRST_RESPONDER_PROJECT: Docs content first responder
|
||||
REPORT_AUTHOR: docubot
|
||||
REPORT_LABEL: broken link report
|
||||
REPORT_REPOSITORY: github/docs-content
|
||||
steps:
|
||||
- name: Check out repo's default branch
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
- name: Setup Node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.13.x
|
||||
cache: npm
|
||||
- name: npm ci
|
||||
run: npm ci
|
||||
- name: npm run build
|
||||
run: npm run build
|
||||
- name: Run script
|
||||
run: |
|
||||
script/check-english-links.js > broken_links.md
|
||||
|
||||
# check-english-links.js returns 0 if no links are broken, and 1 if any links
|
||||
# are broken. When an Actions step's exit code is 1, the action run's job status
|
||||
# is failure and the run ends. The following steps create an issue for the
|
||||
# broken link report only if any links are broken, so {% raw %}`if: ${{ failure() }}`{% endraw %}
|
||||
# ensures the steps run despite the previous step's failure of the job.
|
||||
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Get title for issue
|
||||
id: check
|
||||
run: echo "::set-output name=title::$(head -1 broken_links.md)"
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Create issue from file
|
||||
id: broken-link-report
|
||||
uses: peter-evans/create-issue-from-file@b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e
|
||||
with:
|
||||
token: {% raw %}${{ env.GITHUB_TOKEN }}{% endraw %}
|
||||
|
||||
title: {% raw %}${{ steps.check.outputs.title }}{% endraw %}
|
||||
content-filepath: ./broken_links.md
|
||||
repository: {% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %}
|
||||
labels: {% raw %}${{ env.REPORT_LABEL }}{% endraw %}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Close and/or comment on old issues
|
||||
env:
|
||||
{% raw %}NEW_REPORT_URL: 'https://github.com/${{ env.REPORT_REPOSITORY }}/issues/${{ steps.broken-link-report.outputs.issue-number }}'{% endraw %}
|
||||
run: |
|
||||
gh alias set list-reports "issue list \
|
||||
--repo {% raw %}${{ env.REPORT_REPOSITORY }} \{% endraw %}
|
||||
--author {% raw %}${{ env.REPORT_AUTHOR }} \{% endraw %}
|
||||
--label {% raw %}'${{ env.REPORT_LABEL }}'"{% endraw %}
|
||||
|
||||
# Link to the previous report from the new report that triggered this
|
||||
# workflow run.
|
||||
|
||||
previous_report_url=$(gh list-reports \
|
||||
--state all \
|
||||
--limit 2 \
|
||||
--json url \
|
||||
--jq '.[].url' \
|
||||
| grep -v {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} | head -1)
|
||||
|
||||
gh issue comment {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} --body "⬅️ [Previous report]($previous_report_url)"
|
||||
|
||||
# If an old report is open and assigned to someone, link to the newer
|
||||
# report without closing the old report.
|
||||
|
||||
for issue_url in $(gh list-reports \
|
||||
--json assignees,url \
|
||||
--jq '.[] | select (.assignees != []) | .url'); do
|
||||
if [ "$issue_url" != {% raw %}"${{ env.NEW_REPORT_URL }}"{% endraw %} ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report]({% raw %}${{ env.NEW_REPORT_URL }}{% endraw %})"
|
||||
fi
|
||||
done
|
||||
|
||||
# Link to the newer report from any older report that is still open,
|
||||
# then close the older report and remove it from the first responder's
|
||||
# project board.
|
||||
|
||||
for issue_url in $(gh list-reports \
|
||||
--search 'no:assignee' \
|
||||
--json url \
|
||||
--jq '.[].url'); do
|
||||
if [ "$issue_url" != {% raw %}"${{ env.NEW_REPORT_URL }}"{% endraw %} ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report]({% raw %}${{ env.NEW_REPORT_URL }})"{% endraw %}
|
||||
gh issue close $issue_url
|
||||
gh issue edit $issue_url --remove-project "{% raw %}${{ env.FIRST_RESPONDER_PROJECT }}"{% endraw %}
|
||||
fi
|
||||
done
|
||||
```
|
||||
</tr>
|
||||
</td>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Understanding the example
|
||||
|
||||
{% data reusables.actions.example-explanation-table-intro %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:60%"><b>Código</b></th>
|
||||
<th style="width:40%"><b>Explanation</b></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Check all English links
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
{% data reusables.actions.explanation-name-key %}
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '40 20 * * *' # once a day at 20:40 UTC / 12:40 PST
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines the `workflow_dispatch` and `scheduled` as triggers for the workflow:
|
||||
|
||||
* The `workflow_dispatch` lets you manually run this workflow from the UI. For more information, see [`workflow_dispatch`](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch).
|
||||
* The `schedule` event lets you use `cron` syntax to define a regular interval for automatically triggering the workflow. For more information, see [`schedule`](/actions/reference/events-that-trigger-workflows#schedule).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
permissions:
|
||||
contents: read
|
||||
issues: write
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Modifies the default permissions granted to `GITHUB_TOKEN`. This will vary depending on the needs of your workflow. For more information, see "[Assigning permissions to jobs](/actions/using-jobs/assigning-permissions-to-jobs)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
jobs:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the jobs that run in the workflow file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
check_all_english_links:
|
||||
name: Check all links
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines a job with the ID `check_all_english_links`, and the name `Check all links`, that is stored within the `jobs` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
if: github.repository == 'github/docs-internal'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Only run the `check_all_english_links` job if the repository is named `docs-internal` and is within the `github` organization. Otherwise, the job is marked as _skipped_.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
runs-on: ubuntu-latest
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Configura el job para ejecutarse en un ejecutor Ubuntu Linux. This means that the job will execute on a fresh virtual machine hosted by {% data variables.product.prodname_dotcom %}. For syntax examples using other runners, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
env:
|
||||
GITHUB_TOKEN: {% raw %}${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}{% endraw %}
|
||||
REPORT_AUTHOR: docubot
|
||||
REPORT_LABEL: broken link report
|
||||
REPORT_REPOSITORY: github/docs-content
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates custom environment variables, and redefines the built-in `GITHUB_TOKEN` variable to use a custom [secret](/actions/security-guides/encrypted-secrets). These variables will be referenced later in the workflow.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
steps:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the steps that will run as part of the `check_all_english_links` job. Each job in the workflow has its own `steps` section.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Check out repo's default branch
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `uses` keyword tells the job to retrieve the action named `actions/checkout`. Esta es una acción que revisa tu repositorio y lo descarga al ejecutor, lo que te permite ejecutar acciones contra tu código (tales como las herramientas de prueba). Debes utilizar la acción de verificación cada que tu flujo de trabajo se ejecute contra el código del repositorio o cada que estés utilizando una acción definida en el repositorio.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Setup Node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.8.x
|
||||
cache: npm
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/setup-node` action to install the specified version of the `node` software package on the runner, which gives you access to the `npm` command.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run the "npm ci" command
|
||||
run: npm ci
|
||||
- name: Run the "npm run build" command
|
||||
run: npm run build
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `run` keyword tells the job to execute a command on the runner. In this case, the `npm ci` and `npm run build` commands are run as separate steps to install and build the Node.js application in the repository.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run script
|
||||
run: |
|
||||
script/check-english-links.js > broken_links.md
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This `run` command executes a script that is stored in the repository at `script/check-english-links.js`, and pipes the output to a file called `broken_links.md`.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Get title for issue
|
||||
id: check
|
||||
run: echo "::set-output name=title::$(head -1 broken_links.md)"
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the `check-english-links.js` script detects broken links and returns a non-zero (failure) exit status, then use a [workflow command](/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter) to set an output that has the value of the first line of the `broken_links.md` file (this is used the next step).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Create issue from file
|
||||
id: broken-link-report
|
||||
uses: peter-evans/create-issue-from-file@b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e
|
||||
with:
|
||||
token: {% raw %}${{ env.GITHUB_TOKEN }}{% endraw %}
|
||||
|
||||
title: {% raw %}${{ steps.check.outputs.title }}{% endraw %}
|
||||
content-filepath: ./broken_links.md
|
||||
repository: {% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %}
|
||||
labels: {% raw %}${{ env.REPORT_LABEL }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Uses the `peter-evans/create-issue-from-file` action to create a new {% data variables.product.prodname_dotcom %} issue. This example is pinned to a specific version of the action, using the `b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e` SHA.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Close and/or comment on old issues
|
||||
env:
|
||||
NEW_REPORT_URL: 'https://github.com/{% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %}/issues/{% raw %}${{ steps.broken-link-report.outputs.issue-number }}{% endraw %}'
|
||||
run: |
|
||||
gh alias set list-reports "issue list \
|
||||
--repo {% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %} \
|
||||
--author {% raw %}${{ env.REPORT_AUTHOR }}{% endraw %} \
|
||||
--label '{% raw %}${{ env.REPORT_LABEL }}{% endraw %}'"
|
||||
previous_report_url=$(gh list-reports \
|
||||
--state all \
|
||||
--limit 2 \
|
||||
--json url \
|
||||
--jq '.[].url' \
|
||||
| grep -v {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} | head -1)
|
||||
|
||||
gh issue comment {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} --body "⬅️ [Previous report]($previous_report_url)"
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Uses [`gh issue list`](https://cli.github.com/manual/gh_issue_list) to locate the previously created issue from earlier runs. This is [aliased](https://cli.github.com/manual/gh_alias_set) to `gh list-reports` for simpler processing in later steps. To get the issue URL, the `jq` expression processes the resulting JSON output.
|
||||
|
||||
[`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) is then used to add a comment to the new issue that links to the previous one.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
for issue_url in $(gh list-reports \
|
||||
--json assignees,url \
|
||||
--jq '.[] | select (.assignees != []) | .url'); do
|
||||
if [ "$issue_url" != "${{ env.NEW_REPORT_URL }}" ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report](${{ env.NEW_REPORT_URL }})"
|
||||
fi
|
||||
done
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If an issue from a previous run is open and assigned to someone, then use [`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) to add a comment with a link to the new issue.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
for issue_url in $(gh list-reports \
|
||||
--search 'no:assignee' \
|
||||
--json url \
|
||||
--jq '.[].url'); do
|
||||
if [ "$issue_url" != "{% raw %}${{ env.NEW_REPORT_URL }}{% endraw %}" ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report]({% raw %}${{ env.NEW_REPORT_URL }}{% endraw %})"
|
||||
gh issue close $issue_url
|
||||
gh issue edit $issue_url --remove-project "{% raw %}${{ env.FIRST_RESPONDER_PROJECT }}{% endraw %}"
|
||||
fi
|
||||
done
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If an issue from a previous run is open and is not assigned to anyone, then:
|
||||
|
||||
* Use [`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) to add a comment with a link to the new issue.
|
||||
* Use [`gh issue close`](https://cli.github.com/manual/gh_issue_close) to close the old issue.
|
||||
* Use [`gh issue edit`](https://cli.github.com/manual/gh_issue_edit) to edit the old issue to remove it from a specific {% data variables.product.prodname_dotcom %} project board.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Pasos siguientes
|
||||
|
||||
{% data reusables.actions.learning-actions %}
|
||||
@@ -8,6 +8,7 @@ introLinks:
|
||||
featuredLinks:
|
||||
guides:
|
||||
- /actions/learn-github-actions
|
||||
- /actions/examples
|
||||
- /actions/guides/about-continuous-integration
|
||||
- /actions/deployment/deploying-with-github-actions
|
||||
- /actions/guides/about-packaging-with-github-actions
|
||||
@@ -19,6 +20,7 @@ featuredLinks:
|
||||
popular:
|
||||
- /actions/learn-github-actions/workflow-syntax-for-github-actions
|
||||
- /actions/learn-github-actions
|
||||
- /actions/examples
|
||||
- /actions/learn-github-actions/events-that-trigger-workflows
|
||||
- /actions/learn-github-actions/contexts
|
||||
- /actions/learn-github-actions/expressions
|
||||
@@ -50,6 +52,7 @@ versions:
|
||||
children:
|
||||
- /quickstart
|
||||
- /learn-github-actions
|
||||
- /examples
|
||||
- /using-workflows
|
||||
- /using-jobs
|
||||
- /managing-workflow-runs
|
||||
@@ -66,4 +69,3 @@ children:
|
||||
- /creating-actions
|
||||
- /guides
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Monitorear tus jobs actuales
|
||||
intro: 'Monitor how {% data variables.product.prodname_dotcom %}-hosted runners are processing jobs in your organization or enterprise, and identify any related constraints.'
|
||||
intro: 'Monitorea cómo los ejecutores hospedados en {% data variables.product.prodname_dotcom %} procesan jobs en tu organización o empresa e identifican cualquier limitación relacionada.'
|
||||
versions:
|
||||
feature: github-runner-dashboard
|
||||
shortTitle: Monitorear tus jobs actuales
|
||||
@@ -9,9 +9,9 @@ shortTitle: Monitorear tus jobs actuales
|
||||
{% data reusables.actions.enterprise-beta %}
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
## Viewing active jobs in your organization or enterprise
|
||||
## Ver los jobs activos en tu organización o empresa
|
||||
|
||||
You can get a list of all jobs currently running on {% data variables.product.prodname_dotcom %}-hosted runners in your organization or enterprise.
|
||||
Puedes obtener una lista de todos los jobs que se ejecutan actualmente en los ejecutores hospedados en {% data variables.product.prodname_dotcom %} en tu organización o empresa.
|
||||
|
||||
{% data reusables.actions.github-hosted-runners-navigate-to-repo-org-enterprise %}
|
||||
{% data reusables.actions.github-hosted-runners-table-entry %}
|
||||
|
||||
@@ -140,7 +140,7 @@ jobs:
|
||||
{% raw %}${{ runner.os }}-build-{% endraw %}
|
||||
{% raw %}${{ runner.os }}-{% endraw %}
|
||||
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == false }}{% endraw %}
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == 'false' }}{% endraw %}
|
||||
name: List the state of node modules
|
||||
continue-on-error: true
|
||||
run: npm list
|
||||
@@ -196,7 +196,7 @@ Puedes utilizar la salida de la acción `cache` para hacer algo con base en si s
|
||||
En el flujo de trabajo del ejemplo anterior, hay un paso que lista el estado de los módulos de nodo si se suscitó una omisión de caché:
|
||||
|
||||
```yaml
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == false }}{% endraw %}
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == 'false' }}{% endraw %}
|
||||
name: List the state of node modules
|
||||
continue-on-error: true
|
||||
run: npm list
|
||||
|
||||
@@ -103,11 +103,10 @@ Puedes definir entradas y secretos, las cuales pueden pasarse desde el flujo de
|
||||
required: true
|
||||
```
|
||||
{% endraw %}
|
||||
Para encontrar los detalles de la sintaxis para definir entradas y secretos, consulta [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) y [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets).
|
||||
{% if actions-inherit-secrets-reusable-workflows %}
|
||||
Para encontrar más detalles sobre la sintaxis para definir entradas y secretos, consulta [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs), [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets) y [`on.workflow_call.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_callsecretsinherit).
|
||||
1. En el flujo de trabajo reutilizable, referencia la entrada o secreto que definiste en la clave `on` en el paso anterior. Si los secretos se heredan utilizando `secrets: inherit`, puedes referenciarlos incluso si no se definen en la clave `on`.
|
||||
{%- else %}
|
||||
Para encontrar los detalles de la sintaxis para definir entradas y secretos, consulta [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) y [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets).
|
||||
1. En el flujo de trabajo reutilizable, referencia la entrada o secreto que definiste en la clave `on` en el paso anterior.
|
||||
{%- endif %}
|
||||
|
||||
@@ -194,7 +193,7 @@ Cuando llamas a un flujo de trabajo reutilizable, solo puedes utilizar las sigui
|
||||
* [`jobs.<job_id>.with.<input_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id)
|
||||
* [`jobs.<job_id>.secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets)
|
||||
* [`jobs.<job_id>.secrets.<secret_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id)
|
||||
{% if actions-inherit-secrets-reusable-workflows %}* [`jobs.<job_id>.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_callsecretsinherit){% endif %}
|
||||
{% if actions-inherit-secrets-reusable-workflows %}* [`jobs.<job_id>.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %}
|
||||
* [`jobs.<job_id>.needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)
|
||||
* [`jobs.<job_id>.if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif)
|
||||
* [`jobs.<job_id>.permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions)
|
||||
|
||||
@@ -157,42 +157,6 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% if actions-inherit-secrets-reusable-workflows %}
|
||||
|
||||
#### `on.workflow_call.secrets.inherit`
|
||||
|
||||
Use the `inherit` keyword to pass all the calling workflow's secrets to the called workflow. This includes all secrets the calling workflow has access to, namely organization, repository, and environment secrets. The `inherit` keyword can be used to pass secrets across repositories within the same organization, or across organizations within the same enterprise.
|
||||
|
||||
#### Example
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
pass-secrets-to-workflow:
|
||||
uses: ./.github/workflows/called-workflow.yml
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
pass-secret-to-action:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Use a repo or org secret from the calling workflow.
|
||||
uses: echo ${{ secrets.CALLING_WORKFLOW_SECRET }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{%endif%}
|
||||
|
||||
#### `on.workflow_call.secrets.<secret_id>`
|
||||
|
||||
A string identifier to associate with the secret.
|
||||
@@ -219,7 +183,7 @@ A boolean specifying whether the secret must be supplied.
|
||||
|
||||
## `env`
|
||||
|
||||
A `map` of environment variables that are available to the steps of all jobs in the workflow. You can also set environment variables that are only available to the steps of a single job or to a single step. For more information, see [`jobs.<job_id>.env`](#jobsjob_idenv) and [`jobs.<job_id>.steps[*].env`](#jobsjob_idstepsenv).
|
||||
A `map` of environment variables that are available to the steps of all jobs in the workflow. You can also set environment variables that are only available to the steps of a single job or to a single step. For more information, see [`jobs.<job_id>.env`](#jobsjob_idenv) and [`jobs.<job_id>.steps[*].env`](#jobsjob_idstepsenv).
|
||||
|
||||
Variables in the `env` map cannot be defined in terms of other variables in the map.
|
||||
|
||||
@@ -1028,6 +992,42 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% if actions-inherit-secrets-reusable-workflows %}
|
||||
|
||||
### `jobs.<job_id>.secrets.inherit`
|
||||
|
||||
Use the `inherit` keyword to pass all the calling workflow's secrets to the called workflow. This includes all secrets the calling workflow has access to, namely organization, repository, and environment secrets. The `inherit` keyword can be used to pass secrets across repositories within the same organization, or across organizations within the same enterprise.
|
||||
|
||||
#### Example
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
pass-secrets-to-workflow:
|
||||
uses: ./.github/workflows/called-workflow.yml
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
pass-secret-to-action:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Use a repo or org secret from the calling workflow.
|
||||
run: echo ${{ secrets.CALLING_WORKFLOW_SECRET }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{%endif%}
|
||||
|
||||
### `jobs.<job_id>.secrets.<secret_id>`
|
||||
|
||||
A pair consisting of a string identifier for the secret and the value of the secret. The identifier must match the name of a secret defined by [`on.workflow_call.secrets.<secret_id>`](#onworkflow_callsecretssecret_id) in the called workflow.
|
||||
|
||||
@@ -15,42 +15,42 @@ product: '{% data reusables.gated-features.generated-health-checks %}'
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Generating a Health Check is currently in beta for {% data variables.product.prodname_ghe_server %} and subject to change.
|
||||
** Nota:** El generar una verificación de salud se encuentra actualmente en beta para {% data variables.product.prodname_ghe_server %} y está sujeto a cambios.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About generated Health Checks
|
||||
## Acerca de las verificaciones de salud generadas
|
||||
|
||||
You can create a support bundle for {% data variables.product.product_location %} that contains a lot of data, such as diagnostics and log files. To help analyze and interpret this data, you can generate a Health Check. For more information about support bundles, see "[Providing data to {% data variables.contact.github_support %}](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)."
|
||||
Puedes crear un paquete de compatibilidad para {% data variables.product.product_location %} que contenga muchos datos, tales como los archivos de bitácora y de diagnóstico. Para ayudarte a analizar e interpretar estos datos, puedes generar una verificación de salud. Para obtener más información sobre los paquetes de compatibilidad, consulta la sección "[Proporcionar datos a {% data variables.contact.github_support %}](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)".
|
||||
|
||||
A Health Check provides the following information about {% data variables.product.product_location %}.
|
||||
- Insights into the general health of {% data variables.product.product_location %}, such as upgrade status, storage, and license seat consumption
|
||||
- A security section, which focuses on subdomain isolation and user authentication
|
||||
- Analysis of Git requests, with details about the busiest repositories and Git users
|
||||
- Analysis of API requests, including the busiest times, most frequently requested endpoints, and most active callers
|
||||
Una verificación de salud proporciona la siguiente información sobre {% data variables.product.product_location %}.
|
||||
- La información de la salud general de {% data variables.product.product_location %}, tal como el estado de mejora, almacenamiento y consumo de plazas con licencia
|
||||
- Una sección de seguridad, la cual se enfoca en el aislamiento de subdominios y autenticación de usuarios
|
||||
- El análisis de la solicitud de Git, con los detalles sobre los usuarios de Git y repositorios más ocupados
|
||||
- El análisis de las solicitudes a la API, incluyendo los tiempos más ocupados, las terminales que se solicitan con más frecuencia y los llamadores más activos
|
||||
|
||||
## Generating a Health Check
|
||||
## Generar una verificación de salud
|
||||
|
||||
Before you can generate a Health Check, you must create a support bundle. Para obtener más información, consulta "[Proporcionar datos a {% data variables.contact.github_support %}](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)".
|
||||
Antes de que puedas generar una verificación de salud, debes crear un paquete de compatibilidad. Para obtener más información, consulta "[Proporcionar datos a {% data variables.contact.github_support %}](/support/contacting-github-support/providing-data-to-github-support#creating-and-sharing-support-bundles)".
|
||||
|
||||
1. Navigate to the [{% data variables.contact.support_portal %}](https://support.github.com/).
|
||||
2. In the upper-right corner of the page, click **Premium**.
|
||||
1. Navega al [{% data variables.contact.support_portal %}](https://support.github.com/).
|
||||
2. En la esquina superior derecha de la página, haz clic en **Premium**.
|
||||
|
||||
|
||||
|
||||
|
||||
3. To the right of **Health Checks**, click **Request Health Check**.
|
||||
3. A la derecha de **Verificaciones de salud**, haz clic en **Solicitar una verificación de salud**.
|
||||
|
||||
|
||||
|
||||
|
||||
4. Under "Select an enterprise account", select the dropdown menu and click an enterprise account.
|
||||
4. Debajo de "Seleccionar una cuenta empresarial", selecciona el menú desplegable y haz clic en una cuenta empresarial.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Under "Upload a support bundle", click **Chose File** and choose a file to upload. Then, click **Request Health Check**.
|
||||
5. Debajo de "Cargar un paquete de compatibilidad", haz clic en **Elegir archivo** y elige un archivo para cargar. Luego, haz clic en **Solicitar verificación de salud**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
After you request a Health Check, a job is scheduled to generate the Health Check. After several hours to one day, the generated Health Check will appear in the "Health Checks" section of the {% data variables.contact.support_portal %}.
|
||||
Después de que solicites una verificación de salud, se programará un job para quenerarla. Después de varias horas o hasta un día, la verificación de salud generada aparecerá en la sección de "Verificaciones de salud" del {% data variables.contact.support_portal %}.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -114,41 +114,41 @@ You can create a runner group to manage access to the runner that you added to y
|
||||
1. To the right of "Runner groups", select the **Move to group** dropdown, and click the group that you previously created.
|
||||
{%- endif %}
|
||||
|
||||
You've now deployed a self-hosted runner that can run jobs from {% data variables.product.prodname_actions %} within the organizations that you specified.
|
||||
Ya desplegaste un ejecutor auto-hospedado que puede ejecutar jobs de {% data variables.product.prodname_actions %} dentro de las organizaciones que especificaste.
|
||||
|
||||
## 4. Further restrict access to the self-hosted runner
|
||||
## 4. Restringir aún más el acceso al ejecutor auto-hospedado
|
||||
|
||||
Optionally, organization owners can further restrict the access policy of the runner group that you created. For example, an organization owner could allow only certain repositories in the organization to use the runner group.
|
||||
Opcionalmente, los propietarios de las organizaciones pueden restringir aún más la política de acceso del grupo de ejecutores que creaste. Por ejemplo, los propietarios de las organizaciones podrían permitir que solo ciertos repositorios de la organización utilicen el grupo de ejecutores.
|
||||
|
||||
Para obtener más información, consulta la sección "[Administrar el acceso a los ejecutores auto-hospedados](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)".
|
||||
|
||||
{% ifversion ghec or ghae or ghes > 3.2 %}
|
||||
|
||||
## 5. Automatically scale your self-hosted runners
|
||||
## 5. Escalar automáticamente tus ejecutores auto-hospedados
|
||||
|
||||
Optionally, you can build custom tooling to automatically scale the self-hosted runners for {% ifversion ghec or ghae %}your enterprise{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. For example, your tooling can respond to webhook events from {% data variables.product.product_location %} to automatically scale a cluster of runner machines. Para obtener más información, consulta la sección "[Autoescalar con ejecutores auto-hospedados](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)".
|
||||
Opcionalmente, puedes crear herramientas personalizadas para escalar automáticamente a los ejecutores auto-hospedados para {% ifversion ghec or ghae %}tu empresa{% elsif ghes %}{% data variables.product.product_location %}{% endif %}. Por ejemplo, tus herramientas pueden responder a eventos de webhook de {% data variables.product.product_location %} para escalar automáticamente un clúster de máquinas ejecutoras. Para obtener más información, consulta la sección "[Autoescalar con ejecutores auto-hospedados](/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners)".
|
||||
|
||||
{% endif %}
|
||||
|
||||
## Pasos siguientes
|
||||
|
||||
- You can monitor self-hosted runners and troubleshoot common issues. Para obtener más información, consulta la sección "[Monitorear y solucionar problemas de los ejecutores auto-hospedados](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners)".
|
||||
- Puedes monitorear los ejecutores auto-hospedados y solucionar problemas comunes. Para obtener más información, consulta la sección "[Monitorear y solucionar problemas de los ejecutores auto-hospedados](/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners)".
|
||||
|
||||
- {% data variables.product.company_short %} recommends that you review security considerations for self-hosted runner machines. Para obtener más información, consulta la sección "[Fortalecimiento de seguridad para las {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)".
|
||||
- {% data variables.product.company_short %} te recomienda revisar las consideraciones de seguridad para las máquinas ejecutoras auto-hospedadas. Para obtener más información, consulta la sección "[Fortalecimiento de seguridad para las {% data variables.product.prodname_actions %}](/actions/security-guides/security-hardening-for-github-actions#hardening-for-self-hosted-runners)".
|
||||
|
||||
- {% ifversion ghec %}Si utilizas {% data variables.product.prodname_ghe_server %} o {% data variables.product.prodname_ghe_managed %}, puedes{% elsif ghes or ghae %}Puedes{% endif %} sincronizar manualmente los repositorios de {% data variables.product.prodname_dotcom_the_website %} que contengan acciones hacia tu empresa en {% ifversion ghes or ghae %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_ghe_server %} o {% data variables.product.prodname_ghe_managed %}{% endif %}. Alternatively, you can allow members of your enterprise to automatically access actions from {% data variables.product.prodname_dotcom_the_website %} by using {% data variables.product.prodname_github_connect %}. Para obtener más información, consulta lo siguiente.
|
||||
- {% ifversion ghec %}Si utilizas {% data variables.product.prodname_ghe_server %} o {% data variables.product.prodname_ghe_managed %}, puedes{% elsif ghes or ghae %}Puedes{% endif %} sincronizar manualmente los repositorios de {% data variables.product.prodname_dotcom_the_website %} que contengan acciones hacia tu empresa en {% ifversion ghes or ghae %}{% data variables.product.product_name %}{% elsif ghec %}{% data variables.product.prodname_ghe_server %} o {% data variables.product.prodname_ghe_managed %}{% endif %}. Como alternativa, puedes permitir que los miembros de tu empresa accedan automáticamente a las acciones de {% data variables.product.prodname_dotcom_the_website %} utilizando {% data variables.product.prodname_github_connect %}. Para obtener más información, consulta lo siguiente.
|
||||
|
||||
{%- ifversion ghes or ghae %}
|
||||
- "[Manually syncing actions from {% data variables.product.prodname_dotcom_the_website %}](/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom)"
|
||||
- "[Sincronizar manualmente las acciones de {% data variables.product.prodname_dotcom_the_website %}](/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom)"
|
||||
- "[Habilitar el acceso automático a las acciones de {% data variables.product.prodname_dotcom_the_website %} utilizando {% data variables.product.prodname_github_connect %}](/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)"
|
||||
{%- elsif ghec %}
|
||||
- "Sincronizar acciones manualmente desde {% data variables.product.prodname_dotcom_the_website %}" en la documentación de [{% data variables.product.prodname_ghe_server %}](/enterprise-server@latest//admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom) o de [{% data variables.product.prodname_ghe_managed %}](/github-ae@latest//admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom)
|
||||
- "Habilitar el acceso automático a las acciones de {% data variables.product.prodname_dotcom_the_website %} utilizando {% data variables.product.prodname_github_connect %}" en la documentación de [{% data variables.product.prodname_ghe_server %}](/enterprise-server@latest//admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect) o de [{% data variables.product.prodname_ghe_managed %}](/github-ae@latest//admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)
|
||||
{%- endif %}
|
||||
|
||||
- You can customize the software available on your self-hosted runner machines, or configure your runners to run software similar to {% data variables.product.company_short %}-hosted runners{% ifversion ghes or ghae %} available for customers using {% data variables.product.prodname_dotcom_the_website %}{% endif %}. The software that powers runner machines for {% data variables.product.prodname_actions %} is open source. For more information, see the [`actions/runner`](https://github.com/actions/runner) and [`actions/virtual-environments`](https://github.com/actions/virtual-environments) repositories.
|
||||
- Puedes personalizar el software disponible en tus máquinas ejecutoras auto-hospedadas o configurar tus ejecutores para que ejecuten software similar a aquellos hospedados en {% data variables.product.company_short %}{% ifversion ghes or ghae %} disponible para los clientes que utilizan {% data variables.product.prodname_dotcom_the_website %}{% endif %}. El software que impulsa las máquinas ejecutoras para {% data variables.product.prodname_actions %} es de código abierto. Para obtener más información, consulta los repositorios [`actions/runner`](https://github.com/actions/runner) y [`actions/virtual-environments`](https://github.com/actions/virtual-environments).
|
||||
|
||||
## Leer más
|
||||
|
||||
- "[Configuring the self-hosted runner application as a service](/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service)"
|
||||
- "[Using self-hosted runners in a workflow](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)"
|
||||
- "[Configurar la aplicación del ejecutor auto-hospedado como un servicio](/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service)"
|
||||
- "[Utilizar ejecutores auto-hospedados en un flujo de trabajo](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)"
|
||||
|
||||
@@ -1,39 +1,39 @@
|
||||
---
|
||||
title: Removing a member from your enterprise
|
||||
intro: You can remove a member from all organizations owned by your enterprise.
|
||||
title: Eliminar a un miembro de tu empresa
|
||||
intro: Puedes eliminar a un miembro de todas las organizaciones que le pertenecen a tu empresa.
|
||||
permissions: Enterprise owners can remove an enterprise member from the enterprise.
|
||||
versions:
|
||||
feature: remove-enterprise-members
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
shortTitle: Remove member
|
||||
shortTitle: Eliminar miembro
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The ability to remove enterprise members is in beta and subject to change.
|
||||
**Nota:** La capacidad de eliminar a miembros de las empresas se encuentra en beta y está sujeta a cambios.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About removal of enterprise members
|
||||
## Acerca de la eliminación de miembros de las empresas
|
||||
|
||||
When you remove an enterprise member from your enterprise, the member is removed from all organizations owned by your enterprise.
|
||||
Cuando eliminas a un miembro de tu empresa, este se eliminará de todas las organizaciones que le pertenezcan a ella.
|
||||
|
||||
If the enterprise member you're removing is the last owner of an organization owned by your enterprise, you will become an owner of that organization.
|
||||
Si el miembro empresarial que estás eliminando es el último propietario de una organización que le pertenece a esta, te convertirás en el dueño de dicha organización.
|
||||
|
||||
If your enterprise or any of the organizations owned by your enterprise uses an identity provider (IdP) to manage organization membership, the member may be added back to the organization by the IdP. Make sure to also make any necessary changes in your IdP.
|
||||
Si tu empresa o cualquiera de las organizaciones que le pertenecen a esta utilizan un proveedor de identidad (IdP) para administrar la membrecía de la organización, el miembro podría volverse a agregar a dicha organización mediante el IdP. Asegúrate de también hacer cualquier cambio necesario a tu IdP.
|
||||
|
||||
## Eliminar a un miembro de tu empresa
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If an enterprise member uses only {% data variables.product.prodname_ghe_server %}, and not {% data variables.product.prodname_ghe_cloud %}, you cannot remove the enterprise member this way.
|
||||
**Nota:** Si un miembro de la empresa solo utiliza {% data variables.product.prodname_ghe_server %} y no {% data variables.product.prodname_ghe_cloud %}, no podrás eliminarlo de la empresa de esta forma.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.people-tab %}
|
||||
1. To the right of the person you want to remove, select the {% octicon "gear" aria-label="The gear icon" %} dropdown menu and click **Remove from enterprise**.
|
||||
1. A la derecha de la persona que quieras eliminar, selecciona el menú desplegable de {% octicon "gear" aria-label="The gear icon" %} y haz clic en **Eliminar de la empresa**.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: About GitHub Security Advisories for repositories
|
||||
title: Acerca de las asesorías de seguridad de GitHub para los repositorios
|
||||
intro: 'Puedes usar {% data variables.product.prodname_security_advisories %} para discutir, corregir y publicar información sobre vulnerabilidades de seguridad en tu repositorio.'
|
||||
redirect_from:
|
||||
- /articles/about-maintainer-security-advisories
|
||||
@@ -14,7 +14,7 @@ topics:
|
||||
- Security advisories
|
||||
- Vulnerabilities
|
||||
- CVEs
|
||||
shortTitle: Repository security advisories
|
||||
shortTitle: Asesorías de seguridad de los repositorios
|
||||
---
|
||||
|
||||
{% data reusables.repositories.security-advisory-admin-permissions %}
|
||||
@@ -29,17 +29,17 @@ shortTitle: Repository security advisories
|
||||
|
||||
Con {% data variables.product.prodname_security_advisories %}, puedes:
|
||||
|
||||
1. Crear un borrador de asesoría de seguridad y utilizarlo para debatir de manera privada sobre el impacto de la vulnerabilidad en tu proyecto. For more information, see "[Creating a repository security advisory](/code-security/repository-security-advisories/creating-a-repository-security-advisory)."
|
||||
1. Crear un borrador de asesoría de seguridad y utilizarlo para debatir de manera privada sobre el impacto de la vulnerabilidad en tu proyecto. Para obtener más información, consulta la sección "[Crear una asesoría de seguridad de repositorio](/code-security/repository-security-advisories/creating-a-repository-security-advisory)".
|
||||
2. Colaborar en privado para solucionar la vulnerabilidad en una bifurcación privada temporaria.
|
||||
3. Publica la asesoría de seguridad para alertar a tu comunidad sobre la vulnerabilidad una vez que se lance el parche. For more information, see "[Publishing a repository security advisory](/code-security/repository-security-advisories/publishing-a-repository-security-advisory)."
|
||||
3. Publica la asesoría de seguridad para alertar a tu comunidad sobre la vulnerabilidad una vez que se lance el parche. Para obtener más información, consulta la sección "[Publicar una asesoría de seguridad de repositorio](/code-security/repository-security-advisories/publishing-a-repository-security-advisory)".
|
||||
|
||||
{% data reusables.repositories.security-advisories-republishing %}
|
||||
|
||||
Puedes dar crédito a los individuos que contribuyeron con una asesoría de seguridad. For more information, see "[Editing a repository security advisory](/code-security/repository-security-advisories/editing-a-repository-security-advisory#about-credits-for-security-advisories)."
|
||||
Puedes dar crédito a los individuos que contribuyeron con una asesoría de seguridad. Para obtener más información, consulta la sección "[Editar una asesoría de seguridad de repositorio](/code-security/repository-security-advisories/editing-a-repository-security-advisory#about-credits-for-security-advisories)".
|
||||
|
||||
{% data reusables.repositories.security-guidelines %}
|
||||
|
||||
Si creaste una asesoría de seguridad en tu repositorio, esta permanecerá en tu repositorio. Publicamos las asesorías de seguridad para cualquiera de los ecosistemas compatibles con la gráfica de dependencias de la {% data variables.product.prodname_advisory_database %} en [github.com/advisories](https://github.com/advisories). Anyone can submit a change to an advisory published in the {% data variables.product.prodname_advisory_database %}. For more information, see "[Editing security advisories in the {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database)."
|
||||
Si creaste una asesoría de seguridad en tu repositorio, esta permanecerá en tu repositorio. Publicamos las asesorías de seguridad para cualquiera de los ecosistemas compatibles con la gráfica de dependencias de la {% data variables.product.prodname_advisory_database %} en [github.com/advisories](https://github.com/advisories). Cualquiera puede enviar un cambio a una asesoría que se haya publicado en la {% data variables.product.prodname_advisory_database %}. Para obtener más información, consulta la sección "[Editar las asesorías de seguridad en la {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/editing-security-advisories-in-the-github-advisory-database)".
|
||||
|
||||
Si una asesoría de seguridad es específicamente para npm, también la publicamos en las asesorías de seguridad de npm. Para obtener más información, consulta el sitio [npmjs.com/advisories](https://www.npmjs.com/advisories).
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Publishing a repository security advisory
|
||||
title: Publicar una asesoría de seguridad de repositorio
|
||||
intro: Puedes publicar una asesoría de seguridad para alertar a tu comunidad sobre la vulnerabilidad de seguridad en tu proyecto.
|
||||
redirect_from:
|
||||
- /articles/publishing-a-maintainer-security-advisory
|
||||
@@ -15,7 +15,7 @@ topics:
|
||||
- Vulnerabilities
|
||||
- CVEs
|
||||
- Repositories
|
||||
shortTitle: Publish repository advisories
|
||||
shortTitle: Publicar asesorías de repositorio
|
||||
---
|
||||
|
||||
<!--Marketing-LINK: From /features/security/software-supply-chain page "Publishing a security advisory".-->
|
||||
@@ -28,7 +28,7 @@ Cualquiera con permisos de administrador en una asesoría de seguridad puede pub
|
||||
|
||||
Antes de que puedas publicar una asesoría de seguridad o solicitar un número de identificación de CVE, debes crear un borrador de asesoría de seguridad y proporcionar información acerca de las versiones de tu proyecto que se vieron afectadas por la vulnerabilidad de seguridad. Para obtener más información, consulta la sección "[Crear una asesoría de seguridad de repositorio](/code-security/repository-security-advisories/creating-a-repository-security-advisory)".
|
||||
|
||||
Si creaste una asesoría de seguridad pero no has proporcionado detalles sobre las versiones de tu proyecto que afectó la vulnerabilidad, puedes editarla. For more information, see "[Editing a repository security advisory](/code-security/repository-security-advisories/editing-a-repository-security-advisory)."
|
||||
Si creaste una asesoría de seguridad pero no has proporcionado detalles sobre las versiones de tu proyecto que afectó la vulnerabilidad, puedes editarla. Para obtener más información, consulta la sección "[Editar una asesoría de seguridad de repositorio](/code-security/repository-security-advisories/editing-a-repository-security-advisory)".
|
||||
|
||||
## Acerca de publicar una asesoría de seguridad
|
||||
|
||||
@@ -36,7 +36,7 @@ Cuando publicas una asesoría de seguridad, notificas a tu comunidad acerca de l
|
||||
|
||||
{% data reusables.repositories.security-advisories-republishing %}
|
||||
|
||||
Antes de que publiques una asesoría de seguridad, puedes hacer una colaboración privada para arreglar la vulnerabilidad en una bifurcación privada. For more information, see "[Collaborating in a temporary private fork to resolve a repository security vulnerability](/code-security/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability)."
|
||||
Antes de que publiques una asesoría de seguridad, puedes hacer una colaboración privada para arreglar la vulnerabilidad en una bifurcación privada. Para obtener más información, consulta la sección "[Colaborar en una bifurcación privada temporal para resolver una vulnerabilidad de seguridad](/code-security/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability)".
|
||||
|
||||
{% warning %}
|
||||
|
||||
@@ -81,7 +81,7 @@ El publicar una asesoría de seguridad borra la bifurcación temporal privada pa
|
||||
|
||||
## Solicitar un número de identificación de CVE (Opcional)
|
||||
|
||||
{% data reusables.repositories.request-security-advisory-cve-id %} For more information, see "[About {% data variables.product.prodname_security_advisories %} for repositories](/code-security/repository-security-advisories/about-github-security-advisories-for-repositories#cve-identification-numbers)."
|
||||
{% data reusables.repositories.request-security-advisory-cve-id %} Para obtener más información, consulta la sección "[Acerca de las {% data variables.product.prodname_security_advisories %} para los repositorios](/code-security/repository-security-advisories/about-github-security-advisories-for-repositories#cve-identification-numbers)".
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-security %}
|
||||
@@ -92,4 +92,4 @@ El publicar una asesoría de seguridad borra la bifurcación temporal privada pa
|
||||
|
||||
## Leer más
|
||||
|
||||
- "[Withdrawing a repository security advisory](/code-security/repository-security-advisories/withdrawing-a-repository-security-advisory)"
|
||||
- "[Retirar una asesoría de seguridad de repositorio](/code-security/repository-security-advisories/withdrawing-a-repository-security-advisory)"
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Secret scanning patterns
|
||||
intro: 'Lists of supported secrets and the partners that {% data variables.product.company_short %} works with to prevent fraudulent use of secrets that were committed accidentally.'
|
||||
title: Patrones del escaneo de secretos
|
||||
intro: 'Listas de los secretos compatibles y de los socios con los que trabaja {% data variables.product.company_short %} para prevenir el uso fraudulento de los secretos que se confirmaron por accidente.'
|
||||
product: '{% data reusables.gated-features.secret-scanning-partner %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -19,18 +19,18 @@ redirect_from:
|
||||
{% data reusables.secret-scanning.enterprise-enable-secret-scanning %}
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
## About {% data variables.product.prodname_secret_scanning %} patterns
|
||||
## Acerca de los patrones del {% data variables.product.prodname_secret_scanning %}
|
||||
|
||||
{% data variables.product.product_name %} maintains two different sets of {% data variables.product.prodname_secret_scanning %} patterns:
|
||||
{% data variables.product.product_name %} mantiene dos conjuntos diferentes de patrones del {% data variables.product.prodname_secret_scanning %}:
|
||||
|
||||
1. **Partner patterns.** Used to detect potential secrets in all public repositories. For details, see "[Supported secrets for partner patterns](#supported-secrets-for-partner-patterns)."
|
||||
2. **Advanced security patterns.** Used to detect potential secrets in repositories with {% data variables.product.prodname_secret_scanning %} enabled. {% ifversion ghec %} For details, see "[Supported secrets for advanced security](#supported-secrets-for-advanced-security)."{% endif %}
|
||||
1. **Patrones socios.** Se utilizan para detectar secretos potenciales en todos los repositorios públicos. Para obtener más detalles, consulta la sección "[Secretos compatibles para los patrones asociados](#supported-secrets-for-partner-patterns)".
|
||||
2. **Patrones de seguridad avanzada.** Se utilizan para detectar secretos potenciales en los repositorios que tienen habilitado el {% data variables.product.prodname_secret_scanning %}. {% ifversion ghec %} Para obtener más detalles, consulta la sección "[Secretos compatibles para la seguridad avanzada](#supported-secrets-for-advanced-security)".{% endif %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
Organizations using {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_GH_advanced_security %} can enable {% data variables.product.prodname_secret_scanning_GHAS %} on their repositories. For details of these patterns, see the [{% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).
|
||||
Las organizaciones que utilizan {% data variables.product.prodname_ghe_cloud %} con {% data variables.product.prodname_GH_advanced_security %} pueden habilitar la {% data variables.product.prodname_secret_scanning_GHAS %} en sus repositorios. Para obtener los detalles sobre estos patrones, consulta la [documentaciòn de {% data variables.product.prodname_ghe_cloud %}](/enterprise-cloud@latest/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).
|
||||
{% endif %}
|
||||
|
||||
## Supported secrets for partner patterns
|
||||
## Secretos compatibles para los patrones asociados
|
||||
|
||||
Actualmente, {% data variables.product.product_name %} escanea los repositorios públicos en busca de secretos emitidos por los siguientes proveedores de servicios. Para obtener más información acerca de las {% data variables.product.prodname_secret_scanning_partner %}, consulta la sección "[Acerca del {% data variables.product.prodname_secret_scanning_partner %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-partner-patterns)".
|
||||
|
||||
@@ -38,16 +38,16 @@ Actualmente, {% data variables.product.product_name %} escanea los repositorios
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghec or ghae or ghes %}
|
||||
## Supported secrets{% ifversion ghec %} for advanced security{% endif %}
|
||||
## Secretos compatibles{% ifversion ghec %} para la seguridad avanzada{% endif %}
|
||||
|
||||
When {% data variables.product.prodname_secret_scanning_GHAS %} is enabled, {% data variables.product.prodname_dotcom %} scans for secrets issued by the following service providers. {% ifversion ghec %}For more information about {% data variables.product.prodname_secret_scanning_GHAS %}, see "[About {% data variables.product.prodname_secret_scanning_GHAS %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-advanced-security)."{% endif %}
|
||||
Cuando se habilita la {% data variables.product.prodname_secret_scanning_GHAS %}, {% data variables.product.prodname_dotcom %} escanea en búsqueda de secretos que hayan emitido los siguientes proveedores de servicios. {% ifversion ghec %}Para obtener más información sobre {% data variables.product.prodname_secret_scanning_GHAS %}, consulta la sección "[Acerca del {% data variables.product.prodname_secret_scanning_GHAS %}](/code-security/secret-scanning/about-secret-scanning#about-secret-scanning-for-advanced-security)".{% endif %}
|
||||
|
||||
If you use the REST API for secret scanning, you can use the `Secret type` to report on secrets from specific issuers. Para obtener más información, consulta "[Escaneo de secretos](/enterprise-cloud@latest/rest/secret-scanning)."
|
||||
Si utilizas la API de REST para el escaneo de secretos, puedes utilizar el `Secret type` para reportar secretos de emisores específicos. Para obtener más información, consulta "[Escaneo de secretos](/enterprise-cloud@latest/rest/secret-scanning)."
|
||||
|
||||
{% ifversion ghes > 3.1 or ghae or ghec %}
|
||||
{% note %}
|
||||
|
||||
**Note:** You can also define custom {% data variables.product.prodname_secret_scanning %} patterns for your repository, organization, or enterprise. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)".
|
||||
**Nota:** También puedes definir los patrones personalizados del {% data variables.product.prodname_secret_scanning %} para tu repositorio, organización o empresa. Para obtener más información, consulta la sección "[Definir los patrones personalizados para el {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/defining-custom-patterns-for-secret-scanning)".
|
||||
|
||||
{% endnote %}
|
||||
{% endif %}
|
||||
@@ -60,7 +60,7 @@ If you use the REST API for secret scanning, you can use the `Secret type` to re
|
||||
- "[Asegurar tu repositorio](/code-security/getting-started/securing-your-repository)"
|
||||
- "[Mantener la seguridad en tu cuenta y tus datos](/github/authenticating-to-github/keeping-your-account-and-data-secure)"
|
||||
{%- ifversion fpt or ghec %}
|
||||
- "[{% data variables.product.prodname_secret_scanning_caps %} partner program](/developers/overview/secret-scanning-partner-program)"
|
||||
- "[Programa asociado del {% data variables.product.prodname_secret_scanning_caps %}](/developers/overview/secret-scanning-partner-program)"
|
||||
{%- else %}
|
||||
- "[{% data variables.product.prodname_secret_scanning_caps %} partner program](/free-pro-team@latest/developers/overview/secret-scanning-partner-program)" in the {% data variables.product.prodname_ghe_cloud %} documentation
|
||||
- "[Programa asociado del {% data variables.product.prodname_secret_scanning_caps %}](/free-pro-team@latest/developers/overview/secret-scanning-partner-program)" en la documentación de {% data variables.product.prodname_ghe_cloud %}
|
||||
{% endif %}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Testing dev container configuration changes on a prebuild-enabled branch
|
||||
title: Probar los cambios de configuración de contenedor dev en una rama con precompilación habilitada
|
||||
shortTitle: Cambios de contenedor dev de pruebas
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'Cuando cambias la configuración del contenedor dev para una rama que se habilita para las precompilaciones, debes probar tus cambios en un codespace.'
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Creating a branch to work on an issue
|
||||
intro: You can create a branch to work on an issue directly from the issue page and get started right away.
|
||||
title: Crear una rama para trabajar en una propuesta
|
||||
intro: Puedes crear una rama para trabajar en una propuesta directamente desde la página de propuestas e iniciar de inmediato.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.5'
|
||||
@@ -9,26 +9,26 @@ versions:
|
||||
allowTitleToDifferFromFilename: true
|
||||
topics:
|
||||
- Issues
|
||||
shortTitle: Create branch for issue
|
||||
shortTitle: Crear una rama para una propuesta
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The ability to create a branch for an issue is currently in public beta and subject to change.
|
||||
**Nota:** La capacidad de crear una rama para una propuesta se encuentra actualmente en beta y está sujeta a cambios.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About branches connected to an issue
|
||||
Branches connected to an issue are shown under the "Development" section in the sidebar of an issue. When you create a pull request for one of these branches, it is automatically linked to the issue. The connection with that branch is removed and only the pull request is shown in the "Development" section. Para obtener más información, consulta la sección "[Vincular una solicitud de extracción a un informe de problemas](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)".
|
||||
## Acerca de las ramas conectadas a una propuesta
|
||||
Las ramas conectadas a una propuesta se muestran bajo la sección de "Desarrollo" en la barra lateral de una propuesta. Cuando creas una solicitud de cambios para alguna de estas ramas, esta se enlaza automáticamente a la propuesta. La conexión con esa rama se elimina y solo se muestra la solicitud de cambios en la sección de "Desarrollo". Para obtener más información, consulta la sección "[Vincular una solicitud de extracción a un informe de problemas](/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)".
|
||||
|
||||
## Creating a branch for an issue
|
||||
## Crear una rama para una propuesta
|
||||
|
||||
Anyone with write permission to a repository can create a branch for an issue. You can link multiple branches for an issue.
|
||||
Cualquiera con permisos de escritura en un repositorio puede crear una rama para una propuesta. Puedes enlazar ramas múltiples para una propuesta.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-issues %}
|
||||
3. In the list of issues, click the issue that you would like to create a branch for.
|
||||
4. In the right sidebar under "Development", click **Create a branch**. If the issue already has a linked branch or pull request, click {% octicon "gear" aria-label="The Gear icon" %} and at the bottom of the drop-down menu click **Create a branch**. 
|
||||
5. By default, the new branch is created in the current repository from the default branch. Edit the branch name and details as required in the "Create a branch for this issue" dialog. 
|
||||
6. Choose whether to work on the branch locally or to open it in GitHub Desktop.
|
||||
7. When you are ready to create the branch, click **Create branch**.
|
||||
3. En la lista de propuestas, haz clic en aquella para la cuál t gustaría crear una rama.
|
||||
4. En la barra lateral derecha, debajo de "Desarrollo", haz clic en **Crear una rama**. Si la propuesta ya tiene una rama o solicitud de cambios enlazada, haz cli en {% octicon "gear" aria-label="The Gear icon" %} y, en la parte inferior del menú desplegable, haz clic en **Crear una rama**. 
|
||||
5. Predeterminadamente, se creará la rama nueva en el repositorio actual de la rama predeterminada. Edita el nombre de rama y los detalles como se requiera en el diálogo "Crear una rama para esta propuesta". 
|
||||
6. Elige si quieres trabajar en la rama localmente o abrirla en GitHub Desktop.
|
||||
7. Cuando estés listo para crear la rama, haz clic en **Crear rama**.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Configuring tag protection rules
|
||||
shortTitle: Tag protection rules
|
||||
intro: You can configure tag protection rules for your repository to prevent contributors from creating or deleting tags.
|
||||
title: Configurar las reglas de protección de etiqueta
|
||||
shortTitle: Reglas de protección de etiquetas
|
||||
intro: Puedes configurar las reglas de protección de etiqueta de tu repositorio para prevenir que los contribuyentes creen o borren etiquetas.
|
||||
product: '{% data reusables.gated-features.tag-protection-rules %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -12,18 +12,18 @@ versions:
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Tag protection rules are currently in beta and subject to change.
|
||||
**Nota:** Las reglas de protección de etiqueta se encuentran actualmente en beta y están sujetas a cambios.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
When you add a tag protection rule, all tags that match the pattern provided will be protected. Only users with admin or maintain permissions in the repository will be able to create protected tags, and only users with admin permissions in the repository will be able to delete protected tags. Para obtener más información, consulta la sección "[Roles de repositorio para una organización](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#permissions-for-each-role)". {% data variables.product.prodname_github_apps %} require the `Repository administration: write` permission to modify a protected tag.
|
||||
Cuando agregas la regla de protección de etiquetas, se protegerán todas aquellas que empaten con el patrón proporcionado. Solo los usuarios con permisos de administrador o mantenedor en el repositorio podrán crear etiquetas protegidas y solo los usuarios con permisos administrativos en el repositorio podrán borrar las etiquetas protegidas. Para obtener más información, consulta la sección "[Roles de repositorio para una organización](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#permissions-for-each-role)". {% data variables.product.prodname_github_apps %} requiere que el permiso de `Repository administration: write` modifique una etiqueta protegida.
|
||||
|
||||
{% if custom-repository-roles %}
|
||||
Additionally, you can create custom repository roles to allow other groups of users to create or delete tags that match tag protection rules. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".{% endif %}
|
||||
Adicionalmente, puedes crear roles personalizados de repositorio para permitir que otros grupos de usuarios creen o borren etiquetas que empatan con las reglas de protección de etiqueta. Para obtener más información, consulta la sección "[Administrar los roles personalizados de repositorio en una organización](/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)".{% endif %}
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. In the "Code and automation" section of the sidebar, click **{% octicon "tag" aria-label="The tag icon" %} Tags**.
|
||||
1. Click **New rule**. 
|
||||
1. Under "Tag name pattern", type the pattern of the tags you want to protect. In this example, typing "\*" protects all tags. 
|
||||
1. Click **Add rule**. 
|
||||
1. En la sección de "Código y automatización" de la barra lateral, haz clic en **{% octicon "tag" aria-label="The tag icon" %} Etiquetas**.
|
||||
1. Haz clic en **Regla nueva**. 
|
||||
1. Debajo de "Etiqueta un nombre de patrón", escribe el patrón de las etiquetas que quieras proteger. En este ejemplo, el teclear "\*" protege a todas las etiquetas. 
|
||||
1. Haz clic en **Agregar regla**. 
|
||||
|
||||
@@ -14,4 +14,4 @@ versions:
|
||||
|
||||
## About the Permissions API
|
||||
|
||||
The {% data variables.product.prodname_actions %} Permissions API allows you to set permissions for what enterprises, organizations, and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions{% if actions-workflow-policy %} and reusable workflows{% endif %} are allowed to run.{% ifversion fpt or ghec or ghes %} For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."{% endif %}
|
||||
La API de permisos de {% data variables.product.prodname_actions %} te permite configurar permisos sobre cuáles empresas, organizaciones y repositorios pueden ejecutar {% data variables.product.prodname_actions %} y qué acciones{% if actions-workflow-policy %} y flujos de trabajo reutilizables{% endif %} pueden ejecutarse.{% ifversion fpt or ghec or ghes %} Para obtener más información, consulta la sección "[Límites de uso, facturación y administración](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)".{% endif %}
|
||||
|
||||
@@ -77,3 +77,10 @@ upcoming_changes:
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: jdennes
|
||||
-
|
||||
location: RemovePullRequestFromMergeQueueInput.branch
|
||||
description: 'Se eliminará la `branch`.'
|
||||
reason: PRs are removed from the merge queue for the base branch, the `branch` argument is now a no-op
|
||||
date: '2022-10-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: jhunschejones
|
||||
|
||||
@@ -98,6 +98,13 @@ upcoming_changes:
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: cheshire137
|
||||
-
|
||||
location: RemovePullRequestFromMergeQueueInput.branch
|
||||
description: 'Se eliminará la `branch`.'
|
||||
reason: PRs are removed from the merge queue for the base branch, the `branch` argument is now a no-op
|
||||
date: '2022-10-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: jhunschejones
|
||||
-
|
||||
location: UpdateProjectNextItemFieldInput.fieldWithSettingId
|
||||
description: 'Se eliminará la `fieldWithSettingId`. Utilice `fieldConstraintId` en su lugr'
|
||||
|
||||
@@ -98,6 +98,13 @@ upcoming_changes:
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: cheshire137
|
||||
-
|
||||
location: RemovePullRequestFromMergeQueueInput.branch
|
||||
description: 'Se eliminará la `branch`.'
|
||||
reason: PRs are removed from the merge queue for the base branch, the `branch` argument is now a no-op
|
||||
date: '2022-10-01T00:00:00+00:00'
|
||||
criticality: breaking
|
||||
owner: jhunschejones
|
||||
-
|
||||
location: UpdateProjectNextItemFieldInput.fieldWithSettingId
|
||||
description: 'Se eliminará la `fieldWithSettingId`. Utilice `fieldConstraintId` en su lugr'
|
||||
|
||||
@@ -5,7 +5,7 @@ sections:
|
||||
- "ALTA: Se identificó una vulnerabilidad de desbordamiento de integrales en el analizador de lenguaje de marcado de GitHub, la cual pudo haber ocasionado fugas de información potenciales y RCE. Esta vulnerabilidad la reportó Felix Wilhelm, del proyecto Zero de Google, mediante el programa de Recompensas por Errores de GitHub y se le asignó el CVE-2022-24724."
|
||||
bugs:
|
||||
- Las mejoras fallaron algunas veces si el reloj de una réplica de disponibilidad alta se desincronizó con el primario.
|
||||
- 'OAuth Applications created after September 1st, 2020 were not able to use the [Check an Authorization](https://docs.github.com/en/enterprise-server@3.1/rest/reference/apps#check-an-authorization) API endpoint.'
|
||||
- 'Las aplicaciones de OAuth que se crearon después del 1 de septiembre de 2020 no pudieron utilizar la terminal de la API de [Verificar una autorización](https://docs.github.com/en/enterprise-server@3.1/rest/reference/apps#check-an-authorization).'
|
||||
known_issues:
|
||||
- El registor de npm del {% data variables.product.prodname_registry %} ya no regresa un valor de tiempo en las respuestas de metadatos. Esto se hizo para permitir mejoras de rendimiento sustanciales. Seguimos teniendo todos los datos necesarios para devolver un valor de tiempo como parte de la respuesta de metadatos y terminaremos de devolver este valor ene l futuro una vez que hayamos resuelto los problemas de rendimiento existentes.
|
||||
- En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador.
|
||||
|
||||
@@ -2,10 +2,10 @@
|
||||
date: '2022-03-01'
|
||||
sections:
|
||||
security_fixes:
|
||||
- "HIGH: An integer overflow vulnerability was identified in GitHub's markdown parser that could potentially lead to information leaks and RCE. This vulnerability was reported through the GitHub Bug Bounty program by Felix Wilhelm of Google's Project Zero and has been assigned CVE-2022-24724."
|
||||
- "ALTA: Se identificó una vulnerabilidad de desbordamiento de integrales en el analizador de lenguaje de marcado de GitHub, la cual pudo haber ocasionado fugas de información potenciales y RCE. Esta vulnerabilidad la reportó Felix Wilhelm, del proyecto Zero de Google, mediante el programa de Recompensas por Errores de GitHub y se le asignó el CVE-2022-24724."
|
||||
bugs:
|
||||
- Upgrades could sometimes fail if a high-availability replica's clock was out of sync with the primary.
|
||||
- 'OAuth Applications created after September 1st, 2020 were not able to use the [Check an Authorization](https://docs.github.com/en/enterprise-server@3.2/rest/reference/apps#check-an-authorization) API endpoint.'
|
||||
- Las mejoras fallaron algunas veces si el reloj de una réplica de disponibilidad alta se desincronizó con el primario.
|
||||
- 'Las aplicaciones de OAuth que se crearon después del 1 de septiembre de 2020 no pudieron utilizar la terminal de la API de [Verificar una autorización](https://docs.github.com/en/enterprise-server@3.2/rest/reference/apps#check-an-authorization).'
|
||||
known_issues:
|
||||
- En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador.
|
||||
- Las reglas de cortafuegos personalizadas se eliminan durante el proceso de actualización.
|
||||
|
||||
@@ -5,7 +5,7 @@ sections:
|
||||
- "ALTA: Se identificó una vulnerabilidad de desbordamiento de integrales en el analizador de lenguaje de marcado de GitHub, la cual pudo haber ocasionado fugas de información potenciales y RCE. Esta vulnerabilidad la reportó Felix Wilhelm, del proyecto Zero de Google, mediante el programa de Recompensas por Errores de GitHub y se le asignó el CVE-2022-24724."
|
||||
bugs:
|
||||
- Las mejoras fallaron algunas veces si el reloj de una réplica de disponibilidad alta se desincronizó con el primario.
|
||||
- 'OAuth Applications created after September 1st, 2020 were not able to use the [Check an Authorization](https://docs.github.com/en/enterprise-server@3.3/rest/reference/apps#check-an-authorization) API endpoint.'
|
||||
- 'Las aplicaciones de OAuth que se crearon después del 1 de septiembre de 2020 no pudieron utilizar la terminal de la API de [Verificar una autorización](https://docs.github.com/en/enterprise-server@3.3/rest/reference/apps#check-an-authorization).'
|
||||
known_issues:
|
||||
- Después de haber actualizado a {% data variables.product.prodname_ghe_server %} 3.3, podría que las {% data variables.product.prodname_actions %} no inicien automáticamente. Para resolver este problema, conéctate al aplicativo a través de SSH y ejecuta el comando `ghe-actions-start`.
|
||||
- En una instancia recién configurada de {% data variables.product.prodname_ghe_server %} sin ningún usuario, un atacante podría crear el primer usuario adminsitrador.
|
||||
|
||||
@@ -81,7 +81,7 @@ sections:
|
||||
- Ahora puedes pegar la URL en el texto seleccionado para crear rápidamente un enlace de lenguaje de marcado. Esto funciona en todos los campos con lenguaje de marcado habilitado, tal como los comentarios en las propuestas y las descripciones en las solicitudes de cambio. Para obtener más información, consulta la sección "[Bitácora de cambios de {% data variables.product.prodname_dotcom %}](https://github.blog/changelog/2021-11-10-linkify-selected-text-on-url-paste/)".
|
||||
- 'Una URL de imagen ahora se puede aplicar con un contexto de tema, tal como `#gh-dark-mode-only`, para definir cómo se muestra la imagen de lenguaje de marcado en un visor. Para obtener más información, consulta la la "[Bitácora de cambios de {% data variables.product.prodname_dotcom %}](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/)".'
|
||||
- Al crear o editar un archivo de gist con la extensión de archivo de lenguaje de marcado (`.md`), ahora puedes utilizar la pestaña de "Vista previa" o "Cambios a la vista previa" para mostrar un lenguaje de marcado que interprete el contenido del archivo. Para obtener más información, consulta la "[Bitácora de cambios de {% data variables.product.prodname_dotcom %}](https://github.blog/changelog/2021-11-17-preview-the-markdown-rendering-of-gists/)".
|
||||
- When typing the name of a {% data variables.product.prodname_dotcom %} user in issues, pull requests and discussions, the @mention suggester now ranks existing participants higher than other {% data variables.product.prodname_dotcom %} users, so that it's more likely the user you're looking for will be listed.
|
||||
- Cuando escribes el nombre de un usuario de {% data variables.product.prodname_dotcom %} en las propuestas, solicitudes de cambio y debates, el recomendador de @menciones ahora da una puntuación más alta a los participantes existentes que a otros usuarios de {% data variables.product.prodname_dotcom %} para que sea más probable que se liste el usuario que estás buscando.
|
||||
- Los idiomas que se escriben de derecha a izquierda ahora son compatibles de forma nativa en los archivos de lenguaje de marcado, propuestas, solicitudes de cambios, debates y comentarios.
|
||||
-
|
||||
heading: 'Cambios en propuestas y sollicitudes de cambio'
|
||||
|
||||
@@ -6,7 +6,7 @@ sections:
|
||||
features:
|
||||
- heading: 'IP exception list for validation testing after maintenance'
|
||||
notes:
|
||||
- "You can now configure an allow list of IP addresses that can access application services on your GitHub Enterprise Server instance while maintenance mode is enabled. Administrators who visit the instance's web interface from an allowed IP address can validate the instance's functionality post-maintenance and before disabling maintenance mode. For more information, see \"[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list).\"\n"
|
||||
- "Ahora puedes configurar una lista de direcciones IP permitidas que pueden acceder a los servicios de aplicación de tu instancia de GitHub Enterprise Server mientras que el modo de mantenimiento está habilitado. Los administradores que visitan la interfaz web de la instancia desde una dirección IP permitida pueden validar la funcionalidad de dicha instancia post-mantenimiento y antes de inhabilitar el modo de mantenimiento. Para obtener más información consulta la sección \"[Habilitar y programar el modo de mantenimiento](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list)\".\n"
|
||||
- heading: 'Custom repository roles are generally available'
|
||||
notes:
|
||||
- "Con los roles de repositorio personalizados, las organizaciones ahora tienen un control más granular sobre los permisos de acceso a los repositorios que pueden otorgar a los usuarios. Para obtener más información, consulta la sección \"[Administrar los roles de repositorio personalizados para una organización] (/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".\n\nUn organizador es quien crea el rol de repositorio personalizado y este está disponible en todos los repositorios de dicha organización. Se puede otorgar un nombre y descripción personalizados a cada rol. Este puede configurarse desde un conjunto de 40 permisos específicos. Una vez que se crea, los administradores de repositorio pueden asignar un rol personalizado a cualquier usuario, equipo o colaborador externo.\n\nLos roles de repositorio personalizados pueden crearse, verse, editarse y borrarse a través de la nueva pestaña de **Roles de repositorio** en los ajustes de una organización. Se puede crear un máximo de 3 roles personalizados dentro de una organización.\n\nLos roles de repositorio también son totalmente compatibles en las API de REST de GitHub Enterprise. La API de organizaciones se puede utilizar para listar todos los roles de repositorio personalizados en una organización y las API existentes para otorgar acceso a los repositorios para individuos y equipos tienen soporte extendido para los roles de repositorio personalizados. Para obtener más información, consulta la sección \"[Organizations](/rest/reference/orgs#list-custom-repository-roles-in-an-organization)\" en la documentación de la API de REST.\n"
|
||||
@@ -36,7 +36,7 @@ sections:
|
||||
- "Ahora puedes configurar GitHub Enterprise Server para que firme automáticamente las confirmaciones que se hacen en la interfaz web, tal como las de editar un archivo o fusionar una solicitud de cambios. Las confirmaciones firmadas aumentan la seguridad de que los cambios vengan de fuentes confiables. Esta característica permite que el ajuste de protección de rama [Requerir confirmaciones firmadas](/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-signed-commits) bloquee las confirmaciones sin firmar para que no ingresen a un repositorio, mientras que permite la entrada de confirmaciones firmadas; incluso aquellas que se hacen en la interfaz web. Para obtener más información, consulta la sección \"[Configurar el firmado de las confirmaciones web](/admin/configuration/configuring-your-enterprise/configuring-web-commit-signing)\".\n"
|
||||
- heading: 'Sync license usage any time'
|
||||
notes:
|
||||
- "For customers that sync license usage between GitHub Enterprise Server and GitHub Enterprise Cloud automatically using GitHub Connect, you now have the ability to sync your license usage independently of the automatic weekly sync. This feature also reports the status of sync job. For more information, see \"[Syncing license usage between GitHub Enterprise Server and GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#manually-syncing-license-usage).\"\n"
|
||||
- "Para los clientes que sincronizan el uso de licencias entre GitHub Enterprise Server y GitHub Enterprise Cloud automáticamente utilizando GitHub Connect, ahora tienen la capacidad de sincronizar su uso de licencia independientemente de la sincronización semanal automática. Esta característica también reporta el estado del job de sincronización. Para obtener más información, consulta la sección \"[Sincronizar el uso de licencias entre GitHub Enterprise Server y GitHub Enterprise Cloud](/billing/managing-your-license-for-github-enterprise/syncing-license-usage-between-github-enterprise-server-and-github-enterprise-cloud#manually-syncing-license-usage)\".\n"
|
||||
- heading: 'Reusable workflows for GitHub Actions are generally available'
|
||||
notes:
|
||||
- "Los flujos de trabajo reutilizables ahora están disponibles en general. Los flujos de trabajo reutilizables te ayudan a reducir la duplicación permitiéndote reutilizar un flujo de trabajo completo como si fuera una acción. Con el lanzamiento de la disponibilidad general, ahora hay varias mejoras disponibles para GitHub Enterprise Server. Para obtener más información, consulta la sección \"[Reutilizar los flujos de trabajo](/actions/using-workflows/reusing-workflows)\".\n\n- Puedes utilizar las salidas para pasar datos de los flujos de trabajo reutilizables a otros jobs en el flujo de trabajo llamante.\n- Puedes pasar secretos de ambiente a los flujos de trabajo reutilizables.\n- La bitácora de auditoría incluye información sobre qué flujos de trabajo reutilizables se utilizan.\n- Los flujos de trabajo reutilizables en el mismo repositorio que el llamante se pueden referenciar con tan solo la ruta y el nombre de archivo (`PATH/FILENAME`). El flujo de trabajo llamado será de la misma confirmación que el llamante.\n"
|
||||
@@ -45,7 +45,7 @@ sections:
|
||||
- "Ahora tienes más control sobre qué ejecutores auto-hospedados realizan actualizaciones de software. Si especificas el marcador `--disableupdate` para el ejecutor, entonces este no intentará realizar una actualización automática de software si está disponible una versión más nueva del ejecutor. Esto te permite actualizar al ejecutor auto-hospedado en tus propios horarios y conviene especialmente si tu ejecutor auto-hospedado está en un contenedor.\n\n Para ver la compatibilidad con el servicio de GitHub Actions, necesitarás actualizar a tu ejecutor manualmente en los 30 días posteriores de que una versión nueva del ejecutor se encuentre disponible, Para ver las instrucciones de cómo instalar la versión más actual del ejecutor, consulta las instrucciones de instalación para [el lanzamiento más reciente en el repositorio del ejecutor](https://github.com/actions/runner/releases).\n"
|
||||
- heading: 'Secure self-hosted runners for GitHub Actions by limiting workflows'
|
||||
notes:
|
||||
- "Organization owners can now increase the security of CI/CD workflows on self-hosted runners by choosing which workflows can access a runner group. Previously, any workflow in a repository, such as an issue labeler, could access the self-hosted runners available to an organization. For more information, see \"[Managing access to self-hosted runners using groups](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-what-workflows-can-access-a-runner-group)\" and the [GitHub Blog](https://github.blog/2022-03-23-github-actions-secure-self-hosted-runners-specific-workflows/).\n"
|
||||
- "Los propietarios de las organizaciones ahora pueden incrementar la seguridad de los flujos de trabajo de IC/DC en los ejecutores auto-hospedados si eligen cuáles de ellos pueden acceder a un grupo de ejecutores. Anteriormente, cualquier flujo de trabajo en un repositorio, tal como un etiquetador de propuestas, podía acceder a los ejecutores auto-hospedados disponibles en una organización. Para obtener más información, consulta la sección \"[Administrar el acceso a los ejecutores auto-hospedados utilizando grupos](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#changing-what-workflows-can-access-a-runner-group) y el [Blog de GitHub](https://github.blog/2022-03-23-github-actions-secure-self-hosted-runners-specific-workflows/).\n"
|
||||
- heading: 'Prevent GitHub Actions from approving pull requests'
|
||||
notes:
|
||||
- "Ahora puedes controlar si las GitHub Actions pueden aprobar solicitudes de cambio. Esta característica proporciona protección para que un usuario que utiliza GitHub Actions no satisfaga el requisito de protección de rama de \"Aprobaciones requeridas\" y fusione un cambio que no revisó otro usuario. Para prevenir que se dañen los flujos de trabajo existentes, la opción **Permitir que las revisiones de GitHub Actions cuenten en las aprobaciones requeridas** está habilitada predeterminadamente. Los propietarios de organización pueden inhabilitar la característica en los ajustes de GitHub Actions de la organización. Para obtener más información, consulta la sección \"[Inhabilitar o limitar las GitHub Actions para tu organización](/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#preventing-github-actions-from-approving-pull-requests)\".\n"
|
||||
@@ -122,7 +122,7 @@ sections:
|
||||
- heading: 'Light high contrast theme is generally available'
|
||||
notes:
|
||||
- "A light high contrast theme, with greater contrast between foreground and background elements, is now generally available. For more information, see \"[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings).\"\n"
|
||||
- heading: 'Tag protection rules'
|
||||
- heading: 'Reglas de protección de etiquetas'
|
||||
notes:
|
||||
- "Repository owners can now configure tag protection rules to protect a repository's tags. Once protected by a tag protection rule, tags matching a specified name pattern can only be created and deleted by users with the Maintain or Admin role in the repository. For more information, see \"[Configuring tag protection rules](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules).\"\n"
|
||||
bugs:
|
||||
@@ -132,8 +132,8 @@ sections:
|
||||
- "La página de alerta del escaneo de código ahora siempre muestra el estado de la alerta y la información de la rama predeterminada. Hay un panel nuevo de \"Ramas afectadas\" en la barra lateral, en donde puedes ver el estado de la alerta en otras ramas. Si la alerta no existe en tu rama predeterminada, la página de la alerta mostrará el estado de \"In branch\" o de \"In pull request\" para la ubicación en donde se haya visto dicha alerta por última vez. Esta mejora facilita entender el estado de las alertas que se hayan introducido en tu base de código. Para obtener más información, consulta la sección \"[Acerca de las alertas del escaneo de código](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details)\".\n\nLa página de lista de alertas no se cambió y se puede filtrar por `branch`. Puedes utilizar la API de escaneo de código para recuperar una información de rama más detallada para las alertas. Para obtener más información, consulta la sección \"[Escaneo de Código](/rest/code-scanning)\" en la documentación de la API de REST.\n"
|
||||
- "El escaneo de código ahora muestra los detalles del origen del análisis de una alerta. Si una alerta tiene más de un origen de análisis, este se muestra en la barra lateral de \"Ramas afectadas\" y en la línea de tiempo de la alerta. Puedes pasar el mouse sobre el icono de origen del análisis si se muestra en la página de alertas. Estas mejoras facilitarán el entendimiento de tus alertas. Particularmente, te ayudarán a entender aquellas que tengan orígenes de análisis múltiples. Esto es especialmente útil para los ajustes con configuraciones de análisis múltiples, tales como los monorepositorios. Para obtener más información, consulta la sección \"[Acerca de las alertas del escaneo de código](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-analysis-origins)\".\n"
|
||||
- "Lists of repositories owned by a user or organization now have an additional filter option, \"Templates\", making it easier to find template repositories.\n"
|
||||
- "GitHub Enterprise Server can display several common image formats, including PNG, JPG, GIF, PSD, and SVG, and provides several ways to compare differences between versions. Now when reviewing added or changed images in a pull request, previews of those images are shown by default. Previously, you would see a message indicating that binary files could not be shown and you would need to toggle the \"Display rich diff\" option. For more information, see \"[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files).\"\n"
|
||||
- "New gists are now created with a default branch name of either `main` or the alternative default branch name defined in your user settings. This matches how other repositories are created on GitHub Enterprise Server. For more information, see \"[About branches](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch)\" and \"[Managing the default branch name for your repositories](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-the-default-branch-name-for-your-repositories).\"\n"
|
||||
- "GitHub Enterprise Server puede mostrar varios formatos de imagen comunes, incluyendo PNG, JPG, GIF, PSD y SVG y proporciona varias formas de comparar las diferencias entre las versiones. Ahora, cuando revises las imágenes que se agregaron o cambiaron en una solicitud de cambios, las vistas previas de ellas se muestran predeterminadamente. Anteriormente, se veía un mensaje indicando que los archivos binarios no se podían mostrar y necesitabas alternar la opción \"Mostrar el diff enriquecido\". Para obtener más información, consulta la sección \"[Trabajar con archivos que no sean de código](/repositories/working-with-files/using-files/working-with-non-code-files)\".\n"
|
||||
- "Los gists nuevos ahora se crean con un nombre de rama predeterminado ya sea de `main` o del nombre de la rama predeterminada alterna en tus ajustes de usuario. Esto empata con cómo se crean otros repositorios en GitHub Enterprise Server. Para obtener más información, consulta las secciones \"[Acerca de las ramas](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches#about-the-default-branch)\" y \"[Administrar el nombre de rama predeterminada de tus repositorios](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-the-default-branch-name-for-your-repositories)\".\n"
|
||||
- "Gists now only show the 30 most recent comments when first displayed. You can click **Load earlier comments...** to view more. This allows gists that have many comments to appear more quickly. For more information, see \"[Editing and sharing content with gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists).\"\n"
|
||||
- "Settings pages for users, organizations, repositories, and teams have been redesigned, grouping similar settings pages into sections for improved information architecture and discoverability. For more information, see the [GitHub changelog](https://github.blog/changelog/2022-02-02-redesign-of-githubs-settings-pages/).\n"
|
||||
- "Focusing or hovering over a label now displays the label description in a tooltip.\n"
|
||||
@@ -145,7 +145,7 @@ sections:
|
||||
- "GitHub Connect will no longer work after June 3rd for instances running GitHub Enterprise Server 3.1 or older, due to the format of GitHub authentication tokens changing. For more information, see the [GitHub changelog](https://github.blog/changelog/2021-03-31-authentication-token-format-updates-are-generally-available/).\n"
|
||||
- heading: 'CodeQL runner deprecated in favor of CodeQL CLI'
|
||||
notes:
|
||||
- "The CodeQL runner is deprecated in favor of the CodeQL CLI. GitHub Enterprise Server 3.4 and later no longer include the CodeQL runner. This deprecation only affects users who use CodeQL code scanning in 3rd party CI/CD systems. GitHub Actions users are not affected. GitHub strongly recommends that customers migrate to the CodeQL CLI, which is a feature-complete replacement for the CodeQL runner and has many additional features. For more information, see \"[Migrating from the CodeQL runner to CodeQL CLI](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli).\"\n"
|
||||
- "El ejecutor de CodeQL es obsoleto para favorecer al CLI de CodeQL. GitHub Enterprise Server 3.4 y posterior ya no incluyen al ejecutor de CodeQL. Esta obsoletización solo afecta a los usuarios que utilizan el escaneo de código de CodeQL en sistemas de IC/DC de terceros. No se afecta a los usuarios de GitHub Actions. GitHub recomienda fuertemente que los clientes se migren al CLI de CodeQL, lo que es un reemplazo completo de características para el ejecutor de CodeQL y tiene muchas características adicionales. Para obtener más información, consulta la sección \"[Migrarse del ejecutor de CodeQL al CLI de CodeQL](/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/migrating-from-the-codeql-runner-to-codeql-cli)\".\n"
|
||||
- heading: 'Theme picker for GitHub Pages has been removed'
|
||||
notes:
|
||||
- "El selector de tema de GitHub Pages se eliminó de los ajustes de las páginas. Para obtener más información sobre la configuración de temas para GitHub Pages, consulta la sección \"[Agregar un tema a tu sitio de GitHub pages utilizando Jekyll](/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll)\".\n"
|
||||
|
||||
@@ -1 +1 @@
|
||||
{% data variables.product.prodname_actions %} allows {% ifversion ghec or ghae %}members of your enterprise{% elsif ghes %}people who use {% data variables.product.product_location %}{% endif %} to improve productivity by automating every phase of the software development workflow.
|
||||
Las {% data variables.product.prodname_actions %} permiten que {% ifversion ghec or ghae %}los miembros de tu empresa{% elsif ghes %} las personas que utilizan {% data variables.product.product_location %}{% endif %} mejoren su productividad al automatizar cada fase del flujo de trabajo de desarrollo de software.
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
| Cloning your repository to the runner: | [`actions/checkout`](https://github.com/actions/checkout)|
|
||||
@@ -0,0 +1 @@
|
||||
| Controlling how many workflow runs or jobs can run at the same time: | [`concurrency`](/actions/using-jobs/using-concurrency)|
|
||||
@@ -0,0 +1 @@
|
||||
| Running a workflow at regular intervals: | [`schedule`](/actions/learn-github-actions/events-that-trigger-workflows#schedule) |
|
||||
@@ -0,0 +1 @@
|
||||
The following diagram shows a high level view of the workflow's steps and how they run within the job:
|
||||
@@ -0,0 +1 @@
|
||||
The following workflow was created by the {% data variables.product.prodname_dotcom %} Docs Engineering team. To review the latest version of this file in the [`github/docs`](https://github.com/github/docs) repository, see
|
||||
@@ -0,0 +1 @@
|
||||
The following table explains how each of these features are used when creating a {% data variables.product.prodname_actions %} workflow.
|
||||
@@ -0,0 +1 @@
|
||||
The example workflow demonstrates the following capabilities of {% data variables.product.prodname_actions %}:
|
||||
@@ -0,0 +1 @@
|
||||
This article uses an example workflow to demonstrate some of the main CI features of {% data variables.product.prodname_actions %}.
|
||||
@@ -0,0 +1 @@
|
||||
The name of the workflow as it will appear in the "Actions" tab of the {% data variables.product.prodname_dotcom %} repository.
|
||||
@@ -0,0 +1 @@
|
||||
| Preventing a job from running unless specific conditions are met: | [`if`](/actions/using-jobs/using-conditions-to-control-job-execution)|
|
||||
@@ -0,0 +1,4 @@
|
||||
|
||||
- To learn about {% data variables.product.prodname_actions %} concepts, see "[Understanding GitHub Actions](/actions/learn-github-actions/understanding-github-actions)."
|
||||
- For more step-by-step guide for creating a basic workflow, see "[Quickstart for GitHub Actions](/actions/quickstart)."
|
||||
- If you're comfortable with the basics of {% data variables.product.prodname_actions %}, you can learn about workflows and their features at "[About workflows](/actions/using-workflows/about-workflows)."
|
||||
@@ -0,0 +1,5 @@
|
||||
{% note %}
|
||||
|
||||
**Note**: Each line of this workflow is explained in the next section at "[Understanding the example](#understanding-the-example)."
|
||||
|
||||
{% endnote %}
|
||||
@@ -0,0 +1 @@
|
||||
| Setting permissions for the token: | [`permissions`](/actions/using-jobs/assigning-permissions-to-jobs)|
|
||||
@@ -0,0 +1 @@
|
||||
| Triggering a workflow to run automatically: | [`pull_request`](/actions/using-workflows/events-that-trigger-workflows#pull_request) |
|
||||
@@ -0,0 +1 @@
|
||||
| Triggering a workflow to run automatically: | [`push`](/actions/using-workflows/events-that-trigger-workflows#push) |
|
||||
@@ -1,3 +1,3 @@
|
||||
1. Assign a policy for organization access.
|
||||
1. Asigna una política para acceso organizacional.
|
||||
|
||||
You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise.{% ifversion ghec or ghes %} By default, only private repositories can access runners in a runner group, but you can override this. Esta configuración no puede anularse si se configura un grupo ejecutor de la organización que haya compartido una empresa.{% endif %}
|
||||
Puedes configurar un grupo de ejecutores para que una lista de organizaciones específica o todas las organizaciones de la empresa puedan acceder a él.{% ifversion ghec or ghes %} Predeterminadamente, solo los repositorios privados pueden acceder a los ejecutores en un grupo de ejecutores, pero esto se puede ignorar. Esta configuración no puede anularse si se configura un grupo ejecutor de la organización que haya compartido una empresa.{% endif %}
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
| Referencing secrets in a workflow: | [Secrets](/actions/security-guides/encrypted-secrets)|
|
||||
@@ -6,6 +6,6 @@
|
||||
1. Haz clic en **Grupo de ejecución nuevo**.
|
||||
{%- elsif ghes < 3.4 or ghae %}
|
||||
{% data reusables.enterprise-accounts.actions-runners-tab %}
|
||||
1. Use the **Add new** drop-down, and select **New group**.
|
||||
1. Utiliza el menú desplegable **Agregar nuevo** y selecciona **Grupo nuevo**.
|
||||
{%- endif %}
|
||||
1. Under "Group name", type a name for your runner group.
|
||||
1. Debajo de "Nombre de grupo", escribe un nombre para tu grupo de ejecutores.
|
||||
|
||||
@@ -1 +1 @@
|
||||
Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud.
|
||||
Los ejecutores auto-hospedados pueden ser físicos, virtuales, estar en un contenedor, en las instalaciones o en la nube.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{%- ifversion ghes %}
|
||||
- {% data variables.product.prodname_actions %} must be enabled for {% data variables.product.product_name %}. A site administrator can enable and configure {% data variables.product.prodname_actions %} for your instance. Para obtener más información, consulta la sección "[Iniciar con las {% data variables.product.prodname_actions %} para {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server)".
|
||||
- {% data variables.product.prodname_actions %} debe estar habilitado para {% data variables.product.product_name %}. Un administrador de sitio puede habilitar y configurar {% data variables.product.prodname_actions %} para tu instancia. Para obtener más información, consulta la sección "[Iniciar con las {% data variables.product.prodname_actions %} para {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server)".
|
||||
{%- endif %}
|
||||
|
||||
- You must have access to the machine you will use as a self-hosted runner in your environment.
|
||||
- Debes tener acceso a la máquina que utilizarás como ejecutor auto-hospedado en tu ambiente.
|
||||
|
||||
- {% data reusables.actions.self-hosted-runner-ports-protocols %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-ae)."
|
||||
- {% data reusables.actions.self-hosted-runner-ports-protocols %} Para obtener más información, consulta la sección "[Acerca de los ejecutores auto-hospedados](/actions/hosting-your-own-runners/about-self-hosted-runners#communication-between-self-hosted-runners-and-github-ae)".
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
| Installing `node` on the runner: | [`actions/setup-node`](https://github.com/actions/setup-node) |
|
||||
@@ -1 +1 @@
|
||||
- **Tiempo de ejecución del flujo de trabajo** - {% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-6469 %}Cada ejecución de flujo de trabajo se limita a 35 días. Si un flujo de trabajo llega a este límite, se cancelará. Este periodo incluye una duración de ejecución y el tiempo que se gastó en la espera y aprobación.{% else %}Cada flujo de trabajo se limita a 72 horas. If a workflow run reaches this limit, the workflow run is cancelled.{% endif %}
|
||||
- **Tiempo de ejecución del flujo de trabajo** - {% ifversion fpt or ghec or ghes > 3.2 or ghae-issue-6469 %}Cada ejecución de flujo de trabajo se limita a 35 días. Si un flujo de trabajo llega a este límite, se cancelará. Este periodo incluye una duración de ejecución y el tiempo que se gastó en la espera y aprobación.{% else %}Cada flujo de trabajo se limita a 72 horas. Si una ejecución de flujo de trabajo llega a este límite, esta se cancelará.{% endif %}
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
| Manually running a workflow from the UI: | [`workflow_dispatch`](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch)|
|
||||
@@ -1,5 +1,5 @@
|
||||
{% note %}
|
||||
|
||||
**Nota:** Si sincronizas el uso de licencias y tu cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %} no utiliza {% data variables.product.prodname_emus %}, te recomendamos ampliamente que habilites los dominios verificados para tu cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %}. For privacy reasons, your consumed license report only includes the email address associated with a user account on {% data variables.product.prodname_dotcom_the_website %} if the address is hosted by a verified domain. S una persona consume varias licencias por error, el tener acceso a la dirección de correo electrónico que se está utilizando para des-duplicarla facilita mucho la solución de problemas. For more information, see {% ifversion ghec or ghes > 3.1 %}"[Verifying or approving a domain for your enterprise](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)" and {% endif %}"[About {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users){% ifversion not ghec %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% else %}."{% endif %}
|
||||
**Nota:** Si sincronizas el uso de licencias y tu cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %} no utiliza {% data variables.product.prodname_emus %}, te recomendamos ampliamente que habilites los dominios verificados para tu cuenta empresarial en {% data variables.product.prodname_dotcom_the_website %}. Por razones de privacidad, tu reporte de licencias consumidas solo incluye la dirección de correo electrónico asociada con una cuenta de usuario de {% data variables.product.prodname_dotcom_the_website %} si la dirección se hospeda en un dominio verificado. S una persona consume varias licencias por error, el tener acceso a la dirección de correo electrónico que se está utilizando para des-duplicarla facilita mucho la solución de problemas. Para obtener más información, consulta la sección {% ifversion ghec or ghes > 3.1 %}"[Verificar o aprobar un dominio para tu empresa](/enterprise-cloud@latest/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise)" y {% endif %}"[Acerca de las {% data variables.product.prodname_emus %}](/enterprise-cloud@latest/admin/identity-and-access-management/managing-iam-with-enterprise-managed-users/about-enterprise-managed-users){% ifversion not ghec %}" en la documentación de {% data variables.product.prodname_ghe_cloud %}.{% else %}".{% endif %}
|
||||
|
||||
{% endnote %}
|
||||
@@ -1 +1 @@
|
||||
After you synchronize license usage, you can see a report of consumed licenses across all your environments in the enterprise settings on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "[Viewing license usage for {% data variables.product.prodname_enterprise %}](/enterprise-cloud@latest/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)."
|
||||
Después de que sincronizas el uso de licencias, puedes ver un reporte de licencias consumidas en todos tus ambientes en los ajustes de empresa de {% data variables.product.prodname_dotcom_the_website %}. Para obtener más información, consulta la sección "[Ver el uso de licencia para {% data variables.product.prodname_enterprise %}](/enterprise-cloud@latest/billing/managing-your-license-for-github-enterprise/viewing-license-usage-for-github-enterprise)".
|
||||
|
||||
@@ -1 +1 @@
|
||||
Generating a Health Check is available with {% data variables.contact.premium_support %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.contact.premium_support %}](/support/learning-about-github-support/about-github-premium-support)".
|
||||
El generar una verificación de salud se encuentra disponible con {% data variables.contact.premium_support %}. Para obtener más información, consulta la sección "[Acerca de {% data variables.contact.premium_support %}](/support/learning-about-github-support/about-github-premium-support)".
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
{%- ifversion fpt %}
|
||||
{% data variables.product.prodname_secret_scanning_partner_caps %} is automatically run on public repositories in all products on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_secret_scanning_GHAS_caps %} is available for repositories owned by organizations that use {% data variables.product.prodname_ghe_cloud %} and have a license for {% data variables.product.prodname_GH_advanced_security %}.
|
||||
{% data variables.product.prodname_secret_scanning_partner_caps %} se ejecuta automáticamente en los repositorios públicos en todos los productos de {% data variables.product.prodname_dotcom_the_website %}. {% data variables.product.prodname_secret_scanning_GHAS_caps %} se encuentra disponible para los repositorios que pertenecen a las organizaciones que utilizan {% data variables.product.prodname_ghe_cloud %} y tienen una licencia para la {% data variables.product.prodname_GH_advanced_security %}.
|
||||
|
||||
{%- elsif ghec %}
|
||||
{% data variables.product.prodname_secret_scanning_partner_caps %} is automatically run on all public repositories. If you have a license for {% data variables.product.prodname_GH_advanced_security %}, you can enable and configure {% data variables.product.prodname_secret_scanning_GHAS %} for any repository owned by an organization.
|
||||
{% data variables.product.prodname_secret_scanning_partner_caps %} se ejecuta automáticamente en todos los repositorios públicos. Si tienes una licencia de {% data variables.product.prodname_GH_advanced_security %}, puedes habilitar y configurar el
|
||||
{% data variables.product.prodname_secret_scanning_GHAS %} para cualquier repositorio que le pertenezca a una organización.
|
||||
|
||||
{%- elsif ghes %}
|
||||
El {% data variables.product.prodname_secret_scanning_caps %} se encuentra disponible para los repositorios que pertenecen a organizaciones de {% data variables.product.product_name %} si tu empresa tiene una licencia de {% data variables.product.prodname_GH_advanced_security %}.
|
||||
|
||||
@@ -1 +1 @@
|
||||
If SCIM provisioning is implemented for your organization, any changes to a user's organization membership should be triggered from the identity provider. If a user is invited to an organization manually instead of by an existing SCIM integration, their user account may not get properly linked to their SCIM identity. This can prevent the user account from being deprovisioned via SCIM in the future. If a user is removed manually instead of by an existing SCIM integration, a stale linked identity will remain, which can lead to issues if the user needs to re-join the organization.
|
||||
Si se implementó el aprovisionamiento de SCIM para tu organización, cualquier cambio a una membrecía de organización de un usuario deberá activarse desde el proveedor de identidad. Si se invita manualmente a un usuario para pertenecer a una organización en vez de mediante una integración existente de SCIM, la cuenta de usuario podría no enlazarse adecuadamente a su identidad de SCIM. Esto puede prevenir que la cuenta de usuario se desaprovisione a través de SCIM en el futuro. Si se elimina manualmente a un usuario en vez de mediante una integración existente de SCIM, una identidad enlazada obsoleta permanecerá, lo cual puede ocasionar problemas si el usuario necesita volverse a unir a la organización.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{% note %}
|
||||
|
||||
**Note:** To avoid exceeding the rate limit on {% data variables.product.product_name %}, do not assign more than 1,000 users per hour to the IdP application. If you use groups to assign users to the IdP application, do not add more than 100 users to each group per hour. If you exceed these thresholds, attempts to provision users may fail with a "rate limit" error.
|
||||
**Nota:** Para evitar exceder el límite de tasa en {% data variables.product.product_name %}, no asignes más de 1000 usuarios por hora a la aplicación del IdP. If you use groups to assign users to the IdP application, do not add more than 100 users to each group per hour. If you exceed these thresholds, attempts to provision users may fail with a "rate limit" error.
|
||||
|
||||
{% endnote %}
|
||||
@@ -1 +1 @@
|
||||
1. In the left sidebar, click **{% octicon "accessibility" aria-label="The accessibility icon" %} Accessibility**.
|
||||
1. En la barra lateral izquierda, haz clic en **{% octicon "accessibility" aria-label="The accessibility icon" %} Accesibilidad**.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{% if fixed-width-font-gfm-fields %}
|
||||
|
||||
If you are frequently editing code snippets and tables, you may benefit from enabling a fixed-width font in all comment fields on {% data variables.product.product_name %}. Para obtener más información, consulta la sección "[Habilitar fuentes de ancho fijo en el editor](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor)".
|
||||
Si editas fragmentos de código y tablas frecuentemente, podrías beneficiarte de habilitar una fuente de ancho fijo en todos los campos de comentario en {% data variables.product.product_name %}. Para obtener más información, consulta la sección "[Habilitar fuentes de ancho fijo en el editor](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github#enabling-fixed-width-fonts-in-the-editor)".
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
{% ifversion not ghae %}
|
||||
Add the email address to your account on {% data variables.product.product_name %}, so that your commits are attributed to you and appear in your contributions graph. Para obtener más información, consula la sección "[Agregar una dirección de correo electrónico a tu cuenta de {% data variables.product.prodname_dotcom %}](/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account)".
|
||||
Agrega la dirección de correo electrónico a tu cuenta de {% data variables.product.product_name %} para que tus confirmaciones se te atribuyan y se muestren en tu gráfica de contribuciones. Para obtener más información, consula la sección "[Agregar una dirección de correo electrónico a tu cuenta de {% data variables.product.prodname_dotcom %}](/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account)".
|
||||
{% endif %}
|
||||
|
||||
@@ -1 +1 @@
|
||||
When Git prompts you for your password, enter your personal access token (PAT). Alternatively, you can use a credential helper like [Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager/blob/main/README.md).{% ifversion not ghae %} Password-based authentication for Git has been removed in favor of more secure authentication methods.{% endif %} For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)."
|
||||
Cuando Git pida tu contraseña, ingresa tu token de acceso personal (PAT). Como alternativa, puedes utilizar un asistente de credenciales como [Git Credential Manager](https://github.com/GitCredentialManager/git-credential-manager/blob/main/README.md).{% ifversion not ghae %} La autenticación basada en contraseñas para Git se eliminó para favorecer métodos de autenticación más seguros.{% endif %} Para obtener más información, consulta la sección "[Crear un token de acceso personal](/github/authenticating-to-github/creating-a-personal-access-token)".
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{% ifversion fpt or ghec or ghes > 3.4 or ghae-issue-5658 %}
|
||||
1. En la sección de "Acceso" de la barra lateral, haz clic en **{% octicon "shield-lock" aria-label="The shield-lock icon" %} Contraseña y autenticación**.
|
||||
{% else %}
|
||||
1. En la barra lateral izquierda, da clic en **Seguridad de cuenta**. 
|
||||
1. En la barra lateral izquierda, da clic en **Seguridad de cuenta**. 
|
||||
{% endif %}
|
||||
|
||||
15
translations/ja-JP/content/actions/examples/index.md
Normal file
15
translations/ja-JP/content/actions/examples/index.md
Normal file
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: サンプル
|
||||
shortTitle: サンプル
|
||||
intro: 'Example workflows that demonstrate the CI/CD features of {% data variables.product.prodname_actions %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- using-scripts-to-test-your-code-on-a-runner
|
||||
- using-the-github-cli-on-a-runner
|
||||
- using-concurrency-expressions-and-a-test-matrix
|
||||
---
|
||||
|
||||
@@ -0,0 +1,658 @@
|
||||
---
|
||||
title: 'Using concurrency, expressions, and a test matrix'
|
||||
shortTitle: 'Using concurrency, expressions, and a test matrix'
|
||||
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>= 3.5'
|
||||
ghae: issue-4925
|
||||
ghec: '*'
|
||||
showMiniToc: false
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
- [Example overview](#example-overview)
|
||||
- [Features used in this example](#features-used-in-this-example)
|
||||
- [ワークフローの例](#example-workflow)
|
||||
- [Understanding the example](#understanding-the-example)
|
||||
- [次のステップ](#next-steps)
|
||||
|
||||
## Example overview
|
||||
|
||||
{% data reusables.actions.example-workflow-intro-ci %} When this workflow is triggered, it tests your code using a matrix of test combinations with `npm test`.
|
||||
|
||||
{% data reusables.actions.example-diagram-intro %}
|
||||
|
||||
|
||||
|
||||
## Features used in this example
|
||||
|
||||
{% data reusables.actions.example-table-intro %}
|
||||
|
||||
| **機能** | **Implementation** |
|
||||
| ------ | ------------------ |
|
||||
| | |
|
||||
{% data reusables.actions.workflow-dispatch-table-entry %}
|
||||
{% data reusables.actions.pull-request-table-entry %}
|
||||
{% data reusables.actions.cron-table-entry %}
|
||||
{% data reusables.actions.permissions-table-entry %}
|
||||
{% data reusables.actions.concurrency-table-entry %}
|
||||
| Running the job on different runners, depending on the repository: | [`runs-on`](/actions/using-jobs/choosing-the-runner-for-a-job)|
|
||||
{% data reusables.actions.if-conditions-table-entry %}
|
||||
| Using a matrix to create different test configurations: | [`matrix`](/actions/using-jobs/using-a-build-matrix-for-your-jobs)|
|
||||
{% data reusables.actions.checkout-action-table-entry %}
|
||||
{% data reusables.actions.setup-node-table-entry %}
|
||||
| Caching dependencies: | [`actions/cache`](/actions/advanced-guides/caching-dependencies-to-speed-up-workflows)| | Running tests on the runner: | `npm test`|
|
||||
|
||||
## ワークフローの例
|
||||
|
||||
{% data reusables.actions.example-docs-engineering-intro %} [`test.yml`](https://github.com/github/docs/blob/main/.github/workflows/test.yml).
|
||||
|
||||
{% data reusables.actions.note-understanding-example %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:100%"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Node.js Tests
|
||||
|
||||
# **What it does**: Runs our tests.
|
||||
# **Why we have it**: We want our tests to pass before merging code.
|
||||
# **Who does it impact**: Docs engineering, open-source engineering contributors.
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
pull_request:
|
||||
push:
|
||||
branches:
|
||||
- gh-readonly-queue/main/**
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
# Needed for the 'trilom/file-changes-action' action
|
||||
pull-requests: read
|
||||
|
||||
# This allows a subsequently queued workflow run to interrupt previous runs
|
||||
concurrency:
|
||||
group: {% raw %}'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'{% endraw %}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
test:
|
||||
# Run on self-hosted if the private repo or ubuntu-latest if the public repo
|
||||
# See pull # 17442 in the private repo for context
|
||||
runs-on: {% raw %}${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}{% endraw %}
|
||||
timeout-minutes: 60
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
# The same array lives in test-windows.yml, so make any updates there too.
|
||||
test-group:
|
||||
[
|
||||
content,
|
||||
graphql,
|
||||
meta,
|
||||
rendering,
|
||||
routing,
|
||||
unit,
|
||||
linting,
|
||||
translations,
|
||||
]
|
||||
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
|
||||
- name: Check out repo
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
# Not all test suites need the LFS files. So instead, we opt to
|
||||
# NOT clone them initially and instead, include them manually
|
||||
# only for the test groups that we know need the files.
|
||||
lfs: {% raw %}${{ matrix.test-group == 'content' }}{% endraw %}
|
||||
# Enables cloning the Early Access repo later with the relevant PAT
|
||||
persist-credentials: 'false'
|
||||
|
||||
- name: Figure out which docs-early-access branch to checkout, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
id: check-early-access
|
||||
uses: {% data reusables.actions.action-github-script %}
|
||||
env:
|
||||
BRANCH_NAME: {% raw %}${{ github.head_ref || github.ref_name }}{% endraw %}
|
||||
with:
|
||||
github-token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
result-encoding: string
|
||||
script: |
|
||||
// If being run from a PR, this becomes 'my-cool-branch'.
|
||||
// If run on main, with the `workflow_dispatch` action for
|
||||
// example, the value becomes 'main'.
|
||||
const { BRANCH_NAME } = process.env
|
||||
try {
|
||||
const response = await github.repos.getBranch({
|
||||
owner: 'github',
|
||||
repo: 'docs-early-access',
|
||||
BRANCH_NAME,
|
||||
})
|
||||
console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`)
|
||||
return BRANCH_NAME
|
||||
} catch (err) {
|
||||
if (err.status === 404) {
|
||||
console.log(`There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`)
|
||||
return 'main'
|
||||
}
|
||||
throw err
|
||||
}
|
||||
|
||||
- name: Check out docs-early-access too, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
repository: github/docs-early-access
|
||||
token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
path: docs-early-access
|
||||
ref: {% raw %}${{ steps.check-early-access.outputs.result }}{% endraw %}
|
||||
|
||||
- name: Merge docs-early-access repo's folders
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
run: |
|
||||
mv docs-early-access/assets assets/images/early-access
|
||||
mv docs-early-access/content content/early-access
|
||||
mv docs-early-access/data data/early-access
|
||||
rm -r docs-early-access
|
||||
|
||||
# This is necessary when LFS files where cloned but does nothing
|
||||
# if actions/checkout was run with `lfs:false`.
|
||||
- name: Checkout LFS objects
|
||||
run: git lfs checkout
|
||||
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
id: get_diff_files
|
||||
with:
|
||||
# So that `steps.get_diff_files.outputs.files` becomes
|
||||
# a string like `foo.js path/bar.md`
|
||||
output: ' '
|
||||
|
||||
- name: Insight into changed files
|
||||
run: |
|
||||
|
||||
# Must to do this because the list of files can be HUGE. Especially
|
||||
# in a repo-sync when there are lots of translation files involved.
|
||||
echo {% raw %}"${{ steps.get_diff_files.outputs.files }}" > get_diff_files.txt{% endraw %}
|
||||
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.14.x
|
||||
cache: npm
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Cache nextjs build
|
||||
uses: {% data reusables.actions.action-cache %}
|
||||
with:
|
||||
path: .next/cache
|
||||
key: {% raw %}${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}{% endraw %}
|
||||
|
||||
- name: Run build script
|
||||
run: npm run build
|
||||
|
||||
- name: Run tests
|
||||
env:
|
||||
DIFF_FILE: get_diff_files.txt
|
||||
CHANGELOG_CACHE_FILE_PATH: tests/fixtures/changelog-feed.json
|
||||
run: npm test -- {% raw %}tests/${{ matrix.test-group }}/{% endraw %}
|
||||
```
|
||||
</tr>
|
||||
</td>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Understanding the example
|
||||
|
||||
{% data reusables.actions.example-explanation-table-intro %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:60%"><b>コード</b></th>
|
||||
<th style="width:40%"><b>Explanation</b></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Node.js Tests
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
{% data reusables.actions.explanation-name-key %}
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
on:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `on` keyword lets you define the events that trigger when the workflow is run. You can define multiple events here. For more information, see "[Triggering a workflow](/actions/using-workflows/triggering-a-workflow#using-events-to-trigger-workflows)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
workflow_dispatch:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `workflow_dispatch` event if you want to be able to manually run this workflow in the UI. For more information, see [`workflow_dispatch`](/actions/reference/events-that-trigger-workflows#workflow_dispatch).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
pull_request:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `pull_request` event, so that the workflow runs automatically every time a pull request is created or updated. For more information, see [`pull_request`](/actions/using-workflows/events-that-trigger-workflows#pull_request).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
push:
|
||||
branches:
|
||||
- gh-readonly-queue/main/**
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `push` event, so that the workflow runs automatically every time a commit is pushed to a branch matching the filter `gh-readonly-queue/main/**`. For more information, see [`push`](/actions/using-workflows/events-that-trigger-workflows#push).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Modifies the default permissions granted to `GITHUB_TOKEN`. This will vary depending on the needs of your workflow. For more information, see "[Assigning permissions to jobs](/actions/using-jobs/assigning-permissions-to-jobs)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
|
||||
```yaml{:copy}
|
||||
concurrency:
|
||||
group: {% raw %}'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates a concurrency group for specific events, and uses the `||` operator to define fallback values. For more information, see "[Using concurrency](/actions/using-jobs/using-concurrency)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
cancel-in-progress: true
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Cancels any currently running job or workflow in the same concurrency group.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
jobs:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the jobs that run in the workflow file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
test:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines a job with the ID `test` that is stored within the `jobs` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
runs-on: {% raw %}${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Configures the job to run on a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner, depending on the repository running the workflow. In this example, the job will run on a self-hosted runner if the repository is named `docs-internal` and is within the `github` organization. If the repository doesn't match this path, then it will run on an `ubuntu-latest` runner hosted by {% data variables.product.prodname_dotcom %}. For more information on these options see "[Choosing the runner for a job](/actions/using-jobs/choosing-the-runner-for-a-job)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
timeout-minutes: 60
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Sets the maximum number of minutes to let the job run before it is automatically canceled. For more information, see [`timeout-minutes`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idtimeout-minutes).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
strategy:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
This section defines the build matrix for your jobs.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
fail-fast: false
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Setting `fail-fast` to `false` prevents {% data variables.product.prodname_dotcom %} from cancelling all in-progress jobs if any matrix job fails.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
matrix:
|
||||
test-group:
|
||||
[
|
||||
content,
|
||||
graphql,
|
||||
meta,
|
||||
rendering,
|
||||
routing,
|
||||
unit,
|
||||
linting,
|
||||
translations,
|
||||
]
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates a matrix named `test-group`, with an array of test groups. These values match the names of test groups that will be run by `npm test`.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
steps:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the steps that will run as part of the `test` job. Each job in a workflow has its own `steps` section.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Check out repo
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
lfs: {% raw %}${{ matrix.test-group == 'content' }}{% endraw %}
|
||||
persist-credentials: 'false'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `uses` keyword tells the job to retrieve the action named `actions/checkout`. これは、リポジトリをチェックアウトしてランナーにダウンロードし、コードに対してアクション（テストツールなど）を実行できるようにします。 ワークフローがリポジトリのコードに対して実行されるとき、またはリポジトリで定義されたアクションを使用しているときはいつでも、チェックアウトアクションを使用する必要があります。 Some extra options are provided to the action using the `with` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Figure out which docs-early-access branch to checkout, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
id: check-early-access
|
||||
uses: {% data reusables.actions.action-github-script %}
|
||||
env:
|
||||
BRANCH_NAME: {% raw %}${{ github.head_ref || github.ref_name }}{% endraw %}
|
||||
with:
|
||||
github-token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
result-encoding: string
|
||||
script: |
|
||||
// If being run from a PR, this becomes 'my-cool-branch'.
|
||||
// If run on main, with the `workflow_dispatch` action for
|
||||
// example, the value becomes 'main'.
|
||||
const { BRANCH_NAME } = process.env
|
||||
try {
|
||||
const response = await github.repos.getBranch({
|
||||
owner: 'github',
|
||||
repo: 'docs-early-access',
|
||||
BRANCH_NAME,
|
||||
})
|
||||
console.log(`Using docs-early-access branch called '${BRANCH_NAME}'.`)
|
||||
return BRANCH_NAME
|
||||
} catch (err) {
|
||||
if (err.status === 404) {
|
||||
console.log(`There is no docs-early-access branch called '${BRANCH_NAME}' so checking out 'main' instead.`)
|
||||
return 'main'
|
||||
}
|
||||
throw err
|
||||
}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the current repository is the `github/docs-internal` repository, this step uses the `actions/github-script` action to run a script to check if there is a branch called `docs-early-access`.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Check out docs-early-access too, if internal repo
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
with:
|
||||
repository: github/docs-early-access
|
||||
token: {% raw %}${{ secrets.DOCUBOT_REPO_PAT }}{% endraw %}
|
||||
path: docs-early-access
|
||||
ref: {% raw %}${{ steps.check-early-access.outputs.result }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the current repository is the `github/docs-internal` repository, this step checks out the branch from the `github/docs-early-access` that was identified in the previous step.
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Merge docs-early-access repo's folders
|
||||
if: {% raw %}${{ github.repository == 'github/docs-internal' }}{% endraw %}
|
||||
run: |
|
||||
mv docs-early-access/assets assets/images/early-access
|
||||
mv docs-early-access/content content/early-access
|
||||
mv docs-early-access/data data/early-access
|
||||
rm -r docs-early-access
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the current repository is the `github/docs-internal` repository, this step uses the `run` keyword to execute shell commands to move the `docs-early-access` repository's folders into the main repository's folders.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Checkout LFS objects
|
||||
run: git lfs checkout
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs a command to check out LFS objects from the repository.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
id: get_diff_files
|
||||
with:
|
||||
# So that `steps.get_diff_files.outputs.files` becomes
|
||||
# a string like `foo.js path/bar.md`
|
||||
output: ' '
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `trilom/file-changes-action` action to gather the files changed in the pull request, so they can be analyzed in the next step. This example is pinned to a specific version of the action, using the `a6ca26c14274c33b15e6499323aac178af06ad4b` SHA.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Insight into changed files
|
||||
run: |
|
||||
echo {% raw %}"${{ steps.get_diff_files.outputs.files }}" > get_diff_files.txt{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs a shell command that uses an output from the previous step to create a file containing the list of files changed in the pull request.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.14.x
|
||||
cache: npm
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/setup-node` action to install the specified version of the `node` software package on the runner, which gives you access to the `npm` command.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs the `npm ci` shell command to install the npm software packages for the project.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Cache nextjs build
|
||||
uses: {% data reusables.actions.action-cache %}
|
||||
with:
|
||||
path: .next/cache
|
||||
key: {% raw %}${{ runner.os }}-nextjs-${{ hashFiles('package*.json') }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/cache` action to cache the Next.js build, so that the workflow will attempt to retrieve a cache of the build, and not rebuild it from scratch every time. For more information, see "[Caching dependencies to speed up workflows](/actions/using-workflows/caching-dependencies-to-speed-up-workflows)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run build script
|
||||
run: npm run build
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs the build script.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run tests
|
||||
env:
|
||||
DIFF_FILE: get_diff_files.txt
|
||||
CHANGELOG_CACHE_FILE_PATH: tests/fixtures/changelog-feed.json
|
||||
run: npm test -- {% raw %}tests/${{ matrix.test-group }}/{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step runs the tests using `npm test`, and the test matrix provides a different value for {% raw %}`${{ matrix.test-group }}`{% endraw %} for each job in the matrix. It uses the `DIFF_FILE` environment variable to know which files have changed, and uses the `CHANGELOG_CACHE_FILE_PATH` environment variable for the changelog cache file.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 次のステップ
|
||||
|
||||
{% data reusables.actions.learning-actions %}
|
||||
@@ -0,0 +1,421 @@
|
||||
---
|
||||
title: Using scripts to test your code on a runner
|
||||
shortTitle: Using scripts to test your code on a runner
|
||||
intro: 'How to use essential {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '> 3.1'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
showMiniToc: false
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
- [Example overview](#example-overview)
|
||||
- [Features used in this example](#features-used-in-this-example)
|
||||
- [ワークフローの例](#example-workflow)
|
||||
- [Understanding the example](#understanding-the-example)
|
||||
- [次のステップ](#next-steps)
|
||||
|
||||
## Example overview
|
||||
|
||||
{% data reusables.actions.example-workflow-intro-ci %} When this workflow is triggered, it automatically runs a script that checks whether the {% data variables.product.prodname_dotcom %} Docs site has any broken links.
|
||||
|
||||
{% data reusables.actions.example-diagram-intro %}
|
||||
|
||||
|
||||
|
||||
## Features used in this example
|
||||
|
||||
{% data reusables.actions.example-table-intro %}
|
||||
|
||||
| **機能** | **Implementation** |
|
||||
| ------ | ------------------ |
|
||||
| | |
|
||||
{% data reusables.actions.push-table-entry %}
|
||||
{% data reusables.actions.pull-request-table-entry %}
|
||||
{% data reusables.actions.workflow-dispatch-table-entry %}
|
||||
{% data reusables.actions.permissions-table-entry %}
|
||||
{% data reusables.actions.concurrency-table-entry %}
|
||||
| Running the job on different runners, depending on the repository: | [`runs-on`](/actions/using-jobs/choosing-the-runner-for-a-job)|
|
||||
{% data reusables.actions.checkout-action-table-entry %}
|
||||
{% data reusables.actions.setup-node-table-entry %}
|
||||
| Using a third-party action: | [`trilom/file-changes-action`](https://github.com/trilom/file-changes-action)| | Running a script on the runner: | Using `./script/rendered-content-link-checker.mjs` |
|
||||
|
||||
## ワークフローの例
|
||||
|
||||
{% data reusables.actions.example-docs-engineering-intro %} [`link-check-all.yml`](https://github.com/github/docs/blob/main/.github/workflows/link-check-all.yml).
|
||||
|
||||
{% data reusables.actions.note-understanding-example %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:100%"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: 'Link Checker: All English'
|
||||
|
||||
# **What it does**: Renders the content of every page and check all internal links.
|
||||
# **Why we have it**: To make sure all links connect correctly.
|
||||
# **Who does it impact**: Docs content.
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
pull_request:
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
# Needed for the 'trilom/file-changes-action' action
|
||||
pull-requests: read
|
||||
|
||||
# This allows a subsequently queued workflow run to interrupt previous runs
|
||||
concurrency:
|
||||
group: {% raw %}'${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'{% endraw %}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
check-links:
|
||||
runs-on: {% raw %}${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}{% endraw %}
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.13.x
|
||||
cache: npm
|
||||
|
||||
- name: Install
|
||||
run: npm ci
|
||||
|
||||
# Creates file "${{ env.HOME }}/files.json", among others
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
with:
|
||||
fileOutput: 'json'
|
||||
|
||||
# For verification
|
||||
- name: Show files changed
|
||||
run: cat $HOME/files.json
|
||||
|
||||
- name: Link check (warnings, changed files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--max 100 \
|
||||
--check-anchors \
|
||||
--check-images \
|
||||
--verbose \
|
||||
--list $HOME/files.json
|
||||
|
||||
- name: Link check (critical, all files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--exit \
|
||||
--verbose \
|
||||
--check-images \
|
||||
--level critical
|
||||
```
|
||||
</tr>
|
||||
</td>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Understanding the example
|
||||
|
||||
{% data reusables.actions.example-explanation-table-intro %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:60%"><b>コード</b></th>
|
||||
<th style="width:40%"><b>Explanation</b></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: 'Link Checker: All English'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
{% data reusables.actions.explanation-name-key %}
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
on:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `on` keyword lets you define the events that trigger when the workflow is run. You can define multiple events here. For more information, see "[Triggering a workflow](/actions/using-workflows/triggering-a-workflow#using-events-to-trigger-workflows)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
workflow_dispatch:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `workflow_dispatch` event if you want to be able to manually run this workflow from the UI. For more information, see [`workflow_dispatch`](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `push` event, so that the workflow runs automatically every time a commit is pushed to a branch called `main`. For more information, see [`push`](/actions/using-workflows/events-that-trigger-workflows#push).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
pull_request:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Add the `pull_request` event, so that the workflow runs automatically every time a pull request is created or updated. For more information, see [`pull_request`](/actions/using-workflows/events-that-trigger-workflows#pull_request).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: read
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Modifies the default permissions granted to `GITHUB_TOKEN`. This will vary depending on the needs of your workflow. For more information, see "[Assigning permissions to jobs](/actions/using-jobs/assigning-permissions-to-jobs)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
concurrency:
|
||||
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
|
||||
```
|
||||
{% endraw %}
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates a concurrency group for specific events, and uses the `||` operator to define fallback values. For more information, see "[Using concurrency](/actions/using-jobs/using-concurrency)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
cancel-in-progress: true
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Cancels any currently running job or workflow in the same concurrency group.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
jobs:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the jobs that run in the workflow file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
check-links:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines a job with the ID `check-links` that is stored within the `jobs` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
{% raw %}
|
||||
```yaml{:copy}
|
||||
runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
|
||||
```
|
||||
{% endraw %}
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Configures the job to run on a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner, depending on the repository running the workflow. In this example, the job will run on a self-hosted runner if the repository is named `docs-internal` and is within the `github` organization. If the repository doesn't match this path, then it will run on an `ubuntu-latest` runner hosted by {% data variables.product.prodname_dotcom %}. For more information on these options see "[Choosing the runner for a job](/actions/using-jobs/choosing-the-runner-for-a-job)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
steps:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the steps that will run as part of the `check-links` job. Each job in a workflow has its own `steps` section.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Checkout
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `uses` keyword tells the job to retrieve the action named `actions/checkout`. これは、リポジトリをチェックアウトしてランナーにダウンロードし、コードに対してアクション（テストツールなど）を実行できるようにします。 ワークフローがリポジトリのコードに対して実行されるとき、またはリポジトリで定義されたアクションを使用しているときはいつでも、チェックアウトアクションを使用する必要があります。
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Setup node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.13.x
|
||||
cache: npm
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/setup-node` action to install the specified version of the Node.js software package on the runner, which gives you access to the `npm` command.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Install
|
||||
run: npm ci
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `run` keyword tells the job to execute a command on the runner. In this case, `npm ci` is used to install the npm software packages for the project.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Gather files changed
|
||||
uses: trilom/file-changes-action@a6ca26c14274c33b15e6499323aac178af06ad4b
|
||||
with:
|
||||
fileOutput: 'json'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Uses the `trilom/file-changes-action` action to gather all the changed files. This example is pinned to a specific version of the action, using the `a6ca26c14274c33b15e6499323aac178af06ad4b` SHA.
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Show files changed
|
||||
run: cat $HOME/files.json
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Lists the contents of `files.json`. This will be visible in the workflow run's log, and can be useful for debugging.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Link check (warnings, changed files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--max 100 \
|
||||
--check-anchors \
|
||||
--check-images \
|
||||
--verbose \
|
||||
--list $HOME/files.json
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses `run` command to execute a script that is stored in the repository at `script/rendered-content-link-checker.mjs` and passes all the parameters it needs to run.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Link check (critical, all files)
|
||||
run: |
|
||||
./script/rendered-content-link-checker.mjs \
|
||||
--language en \
|
||||
--exit \
|
||||
--verbose \
|
||||
--check-images \
|
||||
--level critical
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step also uses `run` command to execute a script that is stored in the repository at `script/rendered-content-link-checker.mjs` and passes a different set of parameters.
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 次のステップ
|
||||
|
||||
{% data reusables.actions.learning-actions %}
|
||||
@@ -0,0 +1,486 @@
|
||||
---
|
||||
title: Using the GitHub CLI on a runner
|
||||
shortTitle: Using the GitHub CLI on a runner
|
||||
intro: 'How to use advanced {% data variables.product.prodname_actions %} features for continuous integration (CI).'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '> 3.1'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
showMiniToc: false
|
||||
type: how_to
|
||||
topics:
|
||||
- Workflows
|
||||
---
|
||||
|
||||
{% data reusables.actions.enterprise-github-hosted-runners %}
|
||||
|
||||
- [Example overview](#example-overview)
|
||||
- [Features used in this example](#features-used-in-this-example)
|
||||
- [ワークフローの例](#example-workflow)
|
||||
- [Understanding the example](#understanding-the-example)
|
||||
- [次のステップ](#next-steps)
|
||||
|
||||
## Example overview
|
||||
|
||||
{% data reusables.actions.example-workflow-intro-ci %} When this workflow is triggered, it automatically runs a script that checks whether the {% data variables.product.prodname_dotcom %} Docs site has any broken links. If any broken links are found, the workflow uses the {% data variables.product.prodname_dotcom %} CLI to create a {% data variables.product.prodname_dotcom %} issue with the details.
|
||||
|
||||
{% data reusables.actions.example-diagram-intro %}
|
||||
|
||||
|
||||
|
||||
## Features used in this example
|
||||
|
||||
{% data reusables.actions.example-table-intro %}
|
||||
|
||||
| **機能** | **Implementation** |
|
||||
| ------ | ------------------ |
|
||||
| | |
|
||||
{% data reusables.actions.cron-table-entry %}
|
||||
{% data reusables.actions.permissions-table-entry %}
|
||||
{% data reusables.actions.if-conditions-table-entry %}
|
||||
{% data reusables.actions.secrets-table-entry %}
|
||||
{% data reusables.actions.checkout-action-table-entry %}
|
||||
{% data reusables.actions.setup-node-table-entry %}
|
||||
| Using a third-party action: | [`peter-evans/create-issue-from-file`](https://github.com/peter-evans/create-issue-from-file)| | Running shell commands on the runner: | [`run`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun) | | Running a script on the runner: | Using `script/check-english-links.js` | | Generating an output file: | Piping the output using the `>` operator | | Checking for existing issues using {% data variables.product.prodname_cli %}: | [`gh issue list`](https://cli.github.com/manual/gh_issue_list) | | Commenting on an issue using {% data variables.product.prodname_cli %}: | [`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) |
|
||||
|
||||
## ワークフローの例
|
||||
|
||||
{% data reusables.actions.example-docs-engineering-intro %} [`check-all-english-links.yml`](https://github.com/github/docs/blob/main/.github/workflows/check-all-english-links.yml).
|
||||
|
||||
{% data reusables.actions.note-understanding-example %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:70%"></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Check all English links
|
||||
|
||||
# **What it does**: This script once a day checks all English links and reports in issues.
|
||||
# **Why we have it**: We want to know if any links break.
|
||||
# **Who does it impact**: Docs content.
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '40 19 * * *' # once a day at 19:40 UTC / 11:40 PST
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
issues: write
|
||||
|
||||
jobs:
|
||||
check_all_english_links:
|
||||
name: Check all links
|
||||
if: github.repository == 'github/docs-internal'
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
GITHUB_TOKEN: {% raw %}${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}{% endraw %}
|
||||
FIRST_RESPONDER_PROJECT: Docs content first responder
|
||||
REPORT_AUTHOR: docubot
|
||||
REPORT_LABEL: broken link report
|
||||
REPORT_REPOSITORY: github/docs-content
|
||||
steps:
|
||||
- name: Check out repo's default branch
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
- name: Setup Node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.13.x
|
||||
cache: npm
|
||||
- name: npm ci
|
||||
run: npm ci
|
||||
- name: npm run build
|
||||
run: npm run build
|
||||
- name: Run script
|
||||
run: |
|
||||
script/check-english-links.js > broken_links.md
|
||||
|
||||
# check-english-links.js returns 0 if no links are broken, and 1 if any links
|
||||
# are broken. When an Actions step's exit code is 1, the action run's job status
|
||||
# is failure and the run ends. The following steps create an issue for the
|
||||
# broken link report only if any links are broken, so {% raw %}`if: ${{ failure() }}`{% endraw %}
|
||||
# ensures the steps run despite the previous step's failure of the job.
|
||||
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Get title for issue
|
||||
id: check
|
||||
run: echo "::set-output name=title::$(head -1 broken_links.md)"
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Create issue from file
|
||||
id: broken-link-report
|
||||
uses: peter-evans/create-issue-from-file@b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e
|
||||
with:
|
||||
token: {% raw %}${{ env.GITHUB_TOKEN }}{% endraw %}
|
||||
|
||||
title: {% raw %}${{ steps.check.outputs.title }}{% endraw %}
|
||||
content-filepath: ./broken_links.md
|
||||
repository: {% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %}
|
||||
labels: {% raw %}${{ env.REPORT_LABEL }}{% endraw %}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Close and/or comment on old issues
|
||||
env:
|
||||
{% raw %}NEW_REPORT_URL: 'https://github.com/${{ env.REPORT_REPOSITORY }}/issues/${{ steps.broken-link-report.outputs.issue-number }}'{% endraw %}
|
||||
run: |
|
||||
gh alias set list-reports "issue list \
|
||||
--repo {% raw %}${{ env.REPORT_REPOSITORY }} \{% endraw %}
|
||||
--author {% raw %}${{ env.REPORT_AUTHOR }} \{% endraw %}
|
||||
--label {% raw %}'${{ env.REPORT_LABEL }}'"{% endraw %}
|
||||
|
||||
# Link to the previous report from the new report that triggered this
|
||||
# workflow run.
|
||||
|
||||
previous_report_url=$(gh list-reports \
|
||||
--state all \
|
||||
--limit 2 \
|
||||
--json url \
|
||||
--jq '.[].url' \
|
||||
| grep -v {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} | head -1)
|
||||
|
||||
gh issue comment {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} --body "⬅️ [Previous report]($previous_report_url)"
|
||||
|
||||
# If an old report is open and assigned to someone, link to the newer
|
||||
# report without closing the old report.
|
||||
|
||||
for issue_url in $(gh list-reports \
|
||||
--json assignees,url \
|
||||
--jq '.[] | select (.assignees != []) | .url'); do
|
||||
if [ "$issue_url" != {% raw %}"${{ env.NEW_REPORT_URL }}"{% endraw %} ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report]({% raw %}${{ env.NEW_REPORT_URL }}{% endraw %})"
|
||||
fi
|
||||
done
|
||||
|
||||
# Link to the newer report from any older report that is still open,
|
||||
# then close the older report and remove it from the first responder's
|
||||
# project board.
|
||||
|
||||
for issue_url in $(gh list-reports \
|
||||
--search 'no:assignee' \
|
||||
--json url \
|
||||
--jq '.[].url'); do
|
||||
if [ "$issue_url" != {% raw %}"${{ env.NEW_REPORT_URL }}"{% endraw %} ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report]({% raw %}${{ env.NEW_REPORT_URL }})"{% endraw %}
|
||||
gh issue close $issue_url
|
||||
gh issue edit $issue_url --remove-project "{% raw %}${{ env.FIRST_RESPONDER_PROJECT }}"{% endraw %}
|
||||
fi
|
||||
done
|
||||
```
|
||||
</tr>
|
||||
</td>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Understanding the example
|
||||
|
||||
{% data reusables.actions.example-explanation-table-intro %}
|
||||
|
||||
<table style="width:350px">
|
||||
<thead>
|
||||
<tr>
|
||||
<th style="width:60%"><b>コード</b></th>
|
||||
<th style="width:40%"><b>Explanation</b></th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
name: Check all English links
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
{% data reusables.actions.explanation-name-key %}
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '40 20 * * *' # once a day at 20:40 UTC / 12:40 PST
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines the `workflow_dispatch` and `scheduled` as triggers for the workflow:
|
||||
|
||||
* The `workflow_dispatch` lets you manually run this workflow from the UI. For more information, see [`workflow_dispatch`](/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch).
|
||||
* The `schedule` event lets you use `cron` syntax to define a regular interval for automatically triggering the workflow. For more information, see [`schedule`](/actions/reference/events-that-trigger-workflows#schedule).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
permissions:
|
||||
contents: read
|
||||
issues: write
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Modifies the default permissions granted to `GITHUB_TOKEN`. This will vary depending on the needs of your workflow. For more information, see "[Assigning permissions to jobs](/actions/using-jobs/assigning-permissions-to-jobs)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
jobs:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the jobs that run in the workflow file.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
check_all_english_links:
|
||||
name: Check all links
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Defines a job with the ID `check_all_english_links`, and the name `Check all links`, that is stored within the `jobs` key.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
if: github.repository == 'github/docs-internal'
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Only run the `check_all_english_links` job if the repository is named `docs-internal` and is within the `github` organization. Otherwise, the job is marked as _skipped_.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
runs-on: ubuntu-latest
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Ubuntu Linux ランナーで実行するようにジョブを設定します。 This means that the job will execute on a fresh virtual machine hosted by {% data variables.product.prodname_dotcom %}. For syntax examples using other runners, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)."
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
env:
|
||||
GITHUB_TOKEN: {% raw %}${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}{% endraw %}
|
||||
REPORT_AUTHOR: docubot
|
||||
REPORT_LABEL: broken link report
|
||||
REPORT_REPOSITORY: github/docs-content
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Creates custom environment variables, and redefines the built-in `GITHUB_TOKEN` variable to use a custom [secret](/actions/security-guides/encrypted-secrets). These variables will be referenced later in the workflow.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
steps:
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Groups together all the steps that will run as part of the `check_all_english_links` job. Each job in the workflow has its own `steps` section.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Check out repo's default branch
|
||||
uses: {% data reusables.actions.action-checkout %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `uses` keyword tells the job to retrieve the action named `actions/checkout`. これは、リポジトリをチェックアウトしてランナーにダウンロードし、コードに対してアクション（テストツールなど）を実行できるようにします。 ワークフローがリポジトリのコードに対して実行されるとき、またはリポジトリで定義されたアクションを使用しているときはいつでも、チェックアウトアクションを使用する必要があります。
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Setup Node
|
||||
uses: {% data reusables.actions.action-setup-node %}
|
||||
with:
|
||||
node-version: 16.8.x
|
||||
cache: npm
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This step uses the `actions/setup-node` action to install the specified version of the `node` software package on the runner, which gives you access to the `npm` command.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run the "npm ci" command
|
||||
run: npm ci
|
||||
- name: Run the "npm run build" command
|
||||
run: npm run build
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
The `run` keyword tells the job to execute a command on the runner. In this case, the `npm ci` and `npm run build` commands are run as separate steps to install and build the Node.js application in the repository.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- name: Run script
|
||||
run: |
|
||||
script/check-english-links.js > broken_links.md
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
This `run` command executes a script that is stored in the repository at `script/check-english-links.js`, and pipes the output to a file called `broken_links.md`.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Get title for issue
|
||||
id: check
|
||||
run: echo "::set-output name=title::$(head -1 broken_links.md)"
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If the `check-english-links.js` script detects broken links and returns a non-zero (failure) exit status, then use a [workflow command](/actions/using-workflows/workflow-commands-for-github-actions#setting-an-output-parameter) to set an output that has the value of the first line of the `broken_links.md` file (this is used the next step).
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Create issue from file
|
||||
id: broken-link-report
|
||||
uses: peter-evans/create-issue-from-file@b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e
|
||||
with:
|
||||
token: {% raw %}${{ env.GITHUB_TOKEN }}{% endraw %}
|
||||
|
||||
title: {% raw %}${{ steps.check.outputs.title }}{% endraw %}
|
||||
content-filepath: ./broken_links.md
|
||||
repository: {% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %}
|
||||
labels: {% raw %}${{ env.REPORT_LABEL }}{% endraw %}
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Uses the `peter-evans/create-issue-from-file` action to create a new {% data variables.product.prodname_dotcom %} issue. This example is pinned to a specific version of the action, using the `b4f9ee0a9d4abbfc6986601d9b1a4f8f8e74c77e` SHA.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
- if: {% raw %}${{ failure() }}{% endraw %}
|
||||
name: Close and/or comment on old issues
|
||||
env:
|
||||
NEW_REPORT_URL: 'https://github.com/{% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %}/issues/{% raw %}${{ steps.broken-link-report.outputs.issue-number }}{% endraw %}'
|
||||
run: |
|
||||
gh alias set list-reports "issue list \
|
||||
--repo {% raw %}${{ env.REPORT_REPOSITORY }}{% endraw %} \
|
||||
--author {% raw %}${{ env.REPORT_AUTHOR }}{% endraw %} \
|
||||
--label '{% raw %}${{ env.REPORT_LABEL }}{% endraw %}'"
|
||||
previous_report_url=$(gh list-reports \
|
||||
--state all \
|
||||
--limit 2 \
|
||||
--json url \
|
||||
--jq '.[].url' \
|
||||
| grep -v {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} | head -1)
|
||||
|
||||
gh issue comment {% raw %}${{ env.NEW_REPORT_URL }}{% endraw %} --body "⬅️ [Previous report]($previous_report_url)"
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
Uses [`gh issue list`](https://cli.github.com/manual/gh_issue_list) to locate the previously created issue from earlier runs. This is [aliased](https://cli.github.com/manual/gh_alias_set) to `gh list-reports` for simpler processing in later steps. To get the issue URL, the `jq` expression processes the resulting JSON output.
|
||||
|
||||
[`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) is then used to add a comment to the new issue that links to the previous one.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
for issue_url in $(gh list-reports \
|
||||
--json assignees,url \
|
||||
--jq '.[] | select (.assignees != []) | .url'); do
|
||||
if [ "$issue_url" != "${{ env.NEW_REPORT_URL }}" ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report](${{ env.NEW_REPORT_URL }})"
|
||||
fi
|
||||
done
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If an issue from a previous run is open and assigned to someone, then use [`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) to add a comment with a link to the new issue.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```yaml{:copy}
|
||||
for issue_url in $(gh list-reports \
|
||||
--search 'no:assignee' \
|
||||
--json url \
|
||||
--jq '.[].url'); do
|
||||
if [ "$issue_url" != "{% raw %}${{ env.NEW_REPORT_URL }}{% endraw %}" ]; then
|
||||
gh issue comment $issue_url --body "➡️ [Newer report]({% raw %}${{ env.NEW_REPORT_URL }}{% endraw %})"
|
||||
gh issue close $issue_url
|
||||
gh issue edit $issue_url --remove-project "{% raw %}${{ env.FIRST_RESPONDER_PROJECT }}{% endraw %}"
|
||||
fi
|
||||
done
|
||||
```
|
||||
</td>
|
||||
<td>
|
||||
|
||||
If an issue from a previous run is open and is not assigned to anyone, then:
|
||||
|
||||
* Use [`gh issue comment`](https://cli.github.com/manual/gh_issue_comment) to add a comment with a link to the new issue.
|
||||
* Use [`gh issue close`](https://cli.github.com/manual/gh_issue_close) to close the old issue.
|
||||
* Use [`gh issue edit`](https://cli.github.com/manual/gh_issue_edit) to edit the old issue to remove it from a specific {% data variables.product.prodname_dotcom %} project board.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## 次のステップ
|
||||
|
||||
{% data reusables.actions.learning-actions %}
|
||||
@@ -8,6 +8,7 @@ introLinks:
|
||||
featuredLinks:
|
||||
guides:
|
||||
- /actions/learn-github-actions
|
||||
- /actions/examples
|
||||
- /actions/guides/about-continuous-integration
|
||||
- /actions/deployment/deploying-with-github-actions
|
||||
- /actions/guides/about-packaging-with-github-actions
|
||||
@@ -19,6 +20,7 @@ featuredLinks:
|
||||
popular:
|
||||
- /actions/learn-github-actions/workflow-syntax-for-github-actions
|
||||
- /actions/learn-github-actions
|
||||
- /actions/examples
|
||||
- /actions/learn-github-actions/events-that-trigger-workflows
|
||||
- /actions/learn-github-actions/contexts
|
||||
- /actions/learn-github-actions/expressions
|
||||
@@ -50,6 +52,7 @@ versions:
|
||||
children:
|
||||
- /quickstart
|
||||
- /learn-github-actions
|
||||
- /examples
|
||||
- /using-workflows
|
||||
- /using-jobs
|
||||
- /managing-workflow-runs
|
||||
|
||||
@@ -140,7 +140,7 @@ jobs:
|
||||
{% raw %}${{ runner.os }}-build-{% endraw %}
|
||||
{% raw %}${{ runner.os }}-{% endraw %}
|
||||
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == false }}{% endraw %}
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == 'false' }}{% endraw %}
|
||||
name: List the state of node modules
|
||||
continue-on-error: true
|
||||
run: npm list
|
||||
@@ -196,7 +196,7 @@ You can use the output of the `cache` action to do something based on whether a
|
||||
In the example workflow above, there is a step that lists the state of the Node modules if a cache miss occurred:
|
||||
|
||||
```yaml
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == false }}{% endraw %}
|
||||
- if: {% raw %}${{ steps.cache-npm.outputs.cache-hit == 'false' }}{% endraw %}
|
||||
name: List the state of node modules
|
||||
continue-on-error: true
|
||||
run: npm list
|
||||
|
||||
@@ -103,11 +103,10 @@ You can define inputs and secrets, which can be passed from the caller workflow
|
||||
required: true
|
||||
```
|
||||
{% endraw %}
|
||||
For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets).
|
||||
{% if actions-inherit-secrets-reusable-workflows %}
|
||||
For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs), [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets) and [`on.workflow_call.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_callsecretsinherit).
|
||||
1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step. If the secrets are inherited using `secrets: inherit`, you can reference them even if they are not defined in the `on` key.
|
||||
{%- else %}
|
||||
For details of the syntax for defining inputs and secrets, see [`on.workflow_call.inputs`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callinputs) and [`on.workflow_call.secrets`](/actions/reference/workflow-syntax-for-github-actions#onworkflow_callsecrets).
|
||||
1. In the reusable workflow, reference the input or secret that you defined in the `on` key in the previous step.
|
||||
{%- endif %}
|
||||
|
||||
@@ -194,7 +193,7 @@ When you call a reusable workflow, you can only use the following keywords in th
|
||||
* [`jobs.<job_id>.with.<input_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idwithinput_id)
|
||||
* [`jobs.<job_id>.secrets`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecrets)
|
||||
* [`jobs.<job_id>.secrets.<secret_id>`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idsecretssecret_id)
|
||||
{% if actions-inherit-secrets-reusable-workflows %}* [`jobs.<job_id>.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#onworkflow_callsecretsinherit){% endif %}
|
||||
{% if actions-inherit-secrets-reusable-workflows %}* [`jobs.<job_id>.secrets.inherit`](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idsecretsinherit){% endif %}
|
||||
* [`jobs.<job_id>.needs`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)
|
||||
* [`jobs.<job_id>.if`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idif)
|
||||
* [`jobs.<job_id>.permissions`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idpermissions)
|
||||
|
||||
@@ -157,42 +157,6 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% if actions-inherit-secrets-reusable-workflows %}
|
||||
|
||||
#### `on.workflow_call.secrets.inherit`
|
||||
|
||||
Use the `inherit` keyword to pass all the calling workflow's secrets to the called workflow. This includes all secrets the calling workflow has access to, namely organization, repository, and environment secrets. The `inherit` keyword can be used to pass secrets across repositories within the same organization, or across organizations within the same enterprise.
|
||||
|
||||
#### サンプル
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
pass-secrets-to-workflow:
|
||||
uses: ./.github/workflows/called-workflow.yml
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
pass-secret-to-action:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Use a repo or org secret from the calling workflow.
|
||||
uses: echo ${{ secrets.CALLING_WORKFLOW_SECRET }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{%endif%}
|
||||
|
||||
#### `on.workflow_call.secrets.<secret_id>`
|
||||
|
||||
A string identifier to associate with the secret.
|
||||
@@ -1028,6 +992,42 @@ jobs:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
{% if actions-inherit-secrets-reusable-workflows %}
|
||||
|
||||
### `jobs.<job_id>.secrets.inherit`
|
||||
|
||||
Use the `inherit` keyword to pass all the calling workflow's secrets to the called workflow. This includes all secrets the calling workflow has access to, namely organization, repository, and environment secrets. The `inherit` keyword can be used to pass secrets across repositories within the same organization, or across organizations within the same enterprise.
|
||||
|
||||
#### サンプル
|
||||
|
||||
{% raw %}
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
pass-secrets-to-workflow:
|
||||
uses: ./.github/workflows/called-workflow.yml
|
||||
secrets: inherit
|
||||
```
|
||||
|
||||
```yaml
|
||||
on:
|
||||
workflow_call:
|
||||
|
||||
jobs:
|
||||
pass-secret-to-action:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Use a repo or org secret from the calling workflow.
|
||||
run: echo ${{ secrets.CALLING_WORKFLOW_SECRET }}
|
||||
```
|
||||
|
||||
{% endraw %}
|
||||
|
||||
{%endif%}
|
||||
|
||||
### `jobs.<job_id>.secrets.<secret_id>`
|
||||
|
||||
A pair consisting of a string identifier for the secret and the value of the secret. The identifier must match the name of a secret defined by [`on.workflow_call.secrets.<secret_id>`](#onworkflow_callsecretssecret_id) in the called workflow.
|
||||
|
||||
@@ -1069,7 +1069,7 @@ topics:
|
||||
| `secret_scanning.enable` | An organization owner enabled secret scanning for all existing{% ifversion ghec %} private or internal{% endif %} repositories. |
|
||||
|
||||
{% if secret-scanning-alert-audit-log %}
|
||||
### `secret_scanning_alert` category actions
|
||||
### `secret_scanning_alert`カテゴリアクション
|
||||
|
||||
| アクション | 説明 |
|
||||
| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: ユーザごとの価格付けについて
|
||||
intro: '{% ifversion fpt or ghec %}For organizations{% ifversion ghec %} and enterprises{% endif %}, your {% else %}Your {% endif %}bill begins with the number of licensed seats you choose.'
|
||||
intro: '{% ifversion fpt or ghec %}Organization{% ifversion ghec %}及びEnterprise{% endif %}については、{% else %}{% endif %}請求書は選択したライセンスシート数から始まります。'
|
||||
redirect_from:
|
||||
- /github/setting-up-and-managing-billing-and-payments-on-github/about-per-user-pricing
|
||||
- /articles/about-per-user-pricing
|
||||
@@ -26,42 +26,42 @@ topics:
|
||||
|
||||
{% else %}
|
||||
|
||||
The foundation of your bill is the number of standard licensed seats that you choose for your{% ifversion ghec %} organization or{% endif %} enterprise.
|
||||
請求書の基盤は、{% ifversion ghec %}Organizationもしくは{% endif %}Enterpriseで選択した標準ライセンスシート数です。
|
||||
|
||||
{% data reusables.enterprise-licensing.unique-user-licensing-model %}
|
||||
|
||||
To ensure the same user isn't consuming more than one license for multiple enterprise deployments, you can synchronize license usage between your {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} environments. For more information, see "[About licenses for GitHub Enterprise](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)."
|
||||
同じユーザが複数のEnterpriseデプロイメントに対して複数のライセンスを消費しないようにするために、ライセンスの使用状況を{% data variables.product.prodname_ghe_server %}と{% data variables.product.prodname_ghe_cloud %}環境間で同期できます。 詳しい情報については「[GitHub Enterpriseのライセンスについて](/billing/managing-your-license-for-github-enterprise/about-licenses-for-github-enterprise)」を参照してください。
|
||||
|
||||
In addition to licensed seats, your bill may include other charges, such as {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[About billing for your enterprise](/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise)."
|
||||
ライセンスシートに加えて、請求書には{% data variables.product.prodname_GH_advanced_security %}などの他の課金が含まれることがあります。 詳しい情報については「[Enterpriseの支払いについて](/billing/managing-billing-for-your-github-account/about-billing-for-your-enterprise)」を参照してください。
|
||||
{% endif %}
|
||||
|
||||
## People that consume a license
|
||||
## ライセンスを消費する人
|
||||
|
||||
Each person consumes one license, and {% data variables.product.company_short %} identifies individuals by primary email address.
|
||||
各ユーザは1つのライセンスを消費し、{% data variables.product.company_short %}は個人をプライマリメールアドレスで識別します。
|
||||
|
||||
{% data variables.product.company_short %} bills for the following people.
|
||||
{% data variables.product.company_short %}は以下の人について請求します。
|
||||
|
||||
{%- ifversion ghec %}
|
||||
- Enterprise owners who are a member or owner of at least one organization in the enterprise
|
||||
- Enterprise中の少なくとも1つのOrganizationのメンバーもしくはオーナーになっているEnterpriseオーナー
|
||||
{%- endif %}
|
||||
- Organization members, including owners
|
||||
- Outside collaborators on private{% ifversion ghec %} or internal{% endif %} repositories owned by your organization, excluding forks
|
||||
- Anyone with a pending invitation to become an organization owner or member
|
||||
- Anyone with a pending invitation to become an outside collaborator on private{% ifversion ghec %} or internal{% endif %} repositories owned by your organization, excluding forks
|
||||
- オーナーを含むOrganizationのメンバー
|
||||
- Organizationが所有するプライベート{% ifversion ghec %}もしくはインターナル{% endif %}リポジトリの外部のコラボレータ。フォークは除く
|
||||
- Organizationオーナーもしくはメンバーになるための招待を保留している人
|
||||
- Organizationが所有しているプライベート{% ifversion ghec %}もしくはインターナル{% endif %}リポジトリの外部のコラボレータになる招待を保留している人。フォークは除く
|
||||
{%- ifversion ghec %}
|
||||
- Each user on any {% data variables.product.prodname_ghe_server %} instance that you deploy
|
||||
- デプロイする{% data variables.product.prodname_ghe_server %}インスタンス上の各ユーザ
|
||||
{%- endif %}
|
||||
- 休眠ユーザ
|
||||
|
||||
{% data variables.product.company_short %} does not bill for any of the following people.
|
||||
{% data variables.product.company_short %}は、以下の人には請求しません。
|
||||
|
||||
{%- ifversion ghec %}
|
||||
- Enterprise owners who are not a member or owner of at least one organization in the enterprise
|
||||
- Enterprise billing managers
|
||||
- Enterprise中の少なくとも1つのOrganizationのメンバーもしくはオーナーになっていないEnterpriseオーナー
|
||||
- Enterpriseの支払いマネージャー
|
||||
{%- endif %}
|
||||
- Organization billing managers{% ifversion ghec %} for individual organizations on {% data variables.product.prodname_ghe_cloud %}{% endif %}
|
||||
- Anyone with a pending invitation to become an{% ifversion ghec %} enterprise or{% endif %} organization billing manager
|
||||
- Anyone with a pending invitation to become an outside collaborator on a public repository owned by your organization
|
||||
- {% ifversion ghec %}{% data variables.product.prodname_ghe_cloud %}上の個々の{% endif %}Organizationの支払いマネージャー
|
||||
- {% ifversion ghec %}Enterpriseもしくは{% endif %}Organizationの支払いマネージャーになるための招待を保留している人
|
||||
- Organizationが所有しているパブリックリポジトリの外部のコラボレータになるための招待を保留している人
|
||||
{%- ifversion ghes %}
|
||||
- 停止されたユーザ
|
||||
{%- endif %}
|
||||
@@ -72,13 +72,13 @@ Each person consumes one license, and {% data variables.product.company_short %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
For more information, see {% ifversion not fpt %}"[Roles in an enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)" or {% endif %}"[Roles in an organization](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)."
|
||||
詳しい情報については{% ifversion not fpt %}「[Enterpriseのロール](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)」もしくは{% endif %}「[Organizationのロール](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)」を参照してください。
|
||||
|
||||
{% data variables.product.company_short %} counts each {% ifversion not fpt %}member or {% endif %}outside collaborator once for billing purposes, even if the user account has {% ifversion not fpt %}membership in multiple organizations in an enterprise or {% endif %}access to multiple repositories owned by your organization. 外部のコラボレータに関する詳しい情報については「[Organization内のリポジトリへの外部のコラボレータの追加](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)」を参照してください。
|
||||
{% data variables.product.company_short %}は、ユーザアカウントが{% ifversion not fpt %}Enterprise内の複数のOrganizationのメンバーシップあるいは{% endif %}Organizationが所有する複数のリポジトリへのアクセスを持っている場合でも、各{% ifversion not fpt %}メンバーもしくは{% endif %}外部のコラボレータを課金のために1回ずつカウントします。 外部のコラボレータに関する詳しい情報については「[Organization内のリポジトリへの外部のコラボレータの追加](/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)」を参照してください。
|
||||
|
||||
{% ifversion ghes %}Suspended users are not counted when calculating the number of licensed users consuming seats. For more information, see "[Suspending and unsuspending users](/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users)."{% endif %}
|
||||
{% ifversion ghes %}サスペンドされたユーザは、シートを消費するライセンスユーザ数の計算の際にカウントされません。 詳しい情報については[ユーザのサスペンドとサスペンドの解除](/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users)を参照してください。{% endif %}
|
||||
|
||||
Dormant users do occupy a seat license.{% ifversion ghes %} As such, you can choose to suspend dormant users to release user licenses.{% endif %} For more information, see "[Managing dormant users](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)."
|
||||
休眠ユーザはシートライセンスを占有します。{% ifversion ghes %}そのため、休眠ユーザをサスペンドして、ユーザライセンスを解放させることもできます。{% endif %}詳しい情報については「[休眠ユーザの管理](/admin/user-management/managing-users-in-your-enterprise/managing-dormant-users)」を参照してください。
|
||||
|
||||
## プランの変更について
|
||||
|
||||
@@ -90,7 +90,7 @@ Dormant users do occupy a seat license.{% ifversion ghes %} As such, you can cho
|
||||
|
||||
{% endif %}
|
||||
|
||||
You can add more licensed seats to your {% ifversion fpt or ghec %} organization{% endif %}{% ifversion ghec %} or{% endif %}{% ifversion ghec or ghes %} enterprise{% endif %} at any time. If you pay for more seats than are being used, you can also reduce the number of seats.{% ifversion fpt %} For more information, see "[Upgrading your {% data variables.product.prodname_dotcom %} subscription](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)" and "[Downgrading your {% data variables.product.prodname_dotcom %} subscription](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription)."
|
||||
{% ifversion fpt or ghec %}Organization{% endif %}{% ifversion ghec %}もしくは{% endif %}{% ifversion ghec or ghes %}Enterprise{% endif %}には、いつでもライセンスシートを追加できます。 使用しているよりも多くのシートに支払いをしているなら、シート数を減らすこともできます。{% ifversion fpt %}詳しい情報については「[{% data variables.product.prodname_dotcom %}プランのアップグレード](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)」及び「[{% data variables.product.prodname_dotcom %}プランのダウングレード](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription)」を参照してください。
|
||||
|
||||
プランに関する質問がある場合は、{% data variables.contact.contact_support %}にお問い合わせください。
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Troubleshooting license usage for GitHub Enterprise
|
||||
intro: You can troubleshoot license usage for your enterprise by auditing license reports.
|
||||
intro: 'You can troubleshoot license usage for your enterprise by auditing license reports.'
|
||||
permissions: 'Enterprise owners can review license usage for {% data variables.product.prodname_enterprise %}.'
|
||||
versions:
|
||||
ghec: '*'
|
||||
@@ -26,20 +26,20 @@ For privacy reasons, enterprise owners cannot directly access the details of use
|
||||
|
||||
## Fields in the consumed license files
|
||||
|
||||
The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise.
|
||||
The {% data variables.product.prodname_dotcom_the_website %} license usage report and {% data variables.product.prodname_ghe_server %} exported license usage file include a variety of fields to help you troubleshoot license usage for your enterprise.
|
||||
### {% data variables.product.prodname_dotcom_the_website %} license usage report (CSV file)
|
||||
|
||||
The license usage report for your enterprise is a CSV file that contains the following information about members of your enterprise. Some fields are specific to your {% data variables.product.prodname_ghe_cloud %} (GHEC) deployment, {% data variables.product.prodname_ghe_server %} (GHES) connected environments, or your {% data variables.product.prodname_vs %} subscriptions (VSS) with GitHub Enterprise.
|
||||
|
||||
| フィールド | 説明 |
|
||||
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 名前 | First and last name for the user's account on GHEC. |
|
||||
| Handle or email | GHEC username, or the email address associated with the user's account on GHES. |
|
||||
| Profile link | Link to the {% data variables.product.prodname_dotcom_the_website %} profile page for the user's account on GHEC. |
|
||||
| License type | Can be one of: `Visual Studio subscription` or `Enterprise`. |
|
||||
| License status | Identifies if a user account on {% data variables.product.prodname_dotcom_the_website %} successfully matched either a {% data variables.product.prodname_vs_subscriber %} or GHES user.<br><br>Can be one of: `Matched`, `Pending Invitation`, `Server Only`, blank. |
|
||||
| Member roles | For each of the organizations the user belongs to on GHEC, the organization name and the person's role in that organization (`Owner` or `Member`) separated by a colon<br><br>Each organization is delimited by a comma. |
|
||||
| Enterprise role | Can be one of: `Owner` or `Member`. |
|
||||
| Field | Description
|
||||
| ----- | -----------
|
||||
| Name | First and last name for the user's account on GHEC.
|
||||
| Handle or email | GHEC username, or the email address associated with the user's account on GHES.
|
||||
| Profile link | Link to the {% data variables.product.prodname_dotcom_the_website %} profile page for the user's account on GHEC.
|
||||
| License type | Can be one of: `Visual Studio subscription` or `Enterprise`.
|
||||
| License status | Identifies if a user account on {% data variables.product.prodname_dotcom_the_website %} successfully matched either a {% data variables.product.prodname_vs_subscriber %} or GHES user.<br><br>Can be one of: `Matched`, `Pending Invitation`, `Server Only`, blank.
|
||||
| Member roles | For each of the organizations the user belongs to on GHEC, the organization name and the person's role in that organization (`Owner` or `Member`) separated by a colon<br><br>Each organization is delimited by a comma.
|
||||
| Enterprise role | Can be one of: `Owner` or `Member`.
|
||||
|
||||
{% data variables.product.prodname_vs_subscriber %}s who are not yet members of at least one organization in your enterprise will be included in the report with a pending invitation status, and will be missing values for the "Name" or "Profile link" field.
|
||||
|
||||
@@ -47,15 +47,15 @@ The license usage report for your enterprise is a CSV file that contains the fol
|
||||
|
||||
Your {% data variables.product.prodname_ghe_server %} license usage is a JSON file that is typically used when performing a manual sync of user licenses between {% data variables.product.prodname_ghe_server %} and {% data variables.product.prodname_ghe_cloud %} deployments. The file contains the following information specific to your {% data variables.product.prodname_ghe_server %} environment.
|
||||
|
||||
| フィールド | 説明 |
|
||||
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| 機能 | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement. |
|
||||
| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance. |
|
||||
| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`. |
|
||||
| ライセンス | {% data variables.product.prodname_ghe_server %} ライセンスのハッシュ. |
|
||||
| Public key | {% data variables.product.prodname_ghe_server %} ライセンスの公開鍵の部分. |
|
||||
| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance. |
|
||||
| バージョン | The version of your {% data variables.product.prodname_ghe_server %} instance. |
|
||||
| Field | Description
|
||||
| ----- | -----------
|
||||
| Features | The {% data variables.product.prodname_github_connect %} features that are enabled on your {% data variables.product.prodname_ghe_server %} instance, and the date and time of enablement.
|
||||
| Host name | The hostname of your {% data variables.product.prodname_ghe_server %} instance.
|
||||
| HTTP only | Whether Transport Layer Security (TLS) is enabled and configured on your {% data variables.product.prodname_ghe_server %} instance. Can be one of: `True` or `False`.
|
||||
| License | A hash of your {% data variables.product.prodname_ghe_server %} license.
|
||||
| Public key | The public key portion of your {% data variables.product.prodname_ghe_server %} license.
|
||||
| Server ID | UUID generated for your {% data variables.product.prodname_ghe_server %} instance.
|
||||
| Version | The version of your {% data variables.product.prodname_ghe_server %} instance.
|
||||
|
||||
## Troubleshooting consumed licenses
|
||||
|
||||
|
||||
@@ -35,7 +35,7 @@ shortTitle: dependabot.ymlの設定
|
||||
|
||||
*dependabot.yml* ファイルには、必須の最上位キーに `version` と `updates` の 2 つがあります。 あるいは、トップレベルの`registries`キー{% ifversion fpt or ghec or ghes > 3.4 %}や`enable-beta-ecosystems`キー{% endif %}を含めることができます。 ファイルは、`version: 2` で始まる必要があります。
|
||||
|
||||
## Configuration options for the *dependabot.yml* file
|
||||
## *dependabot.yml*ファイルの設定オプション
|
||||
|
||||
最上位の `updates` キーは必須です。 これを使用することで、{% data variables.product.prodname_dependabot %} がバージョンやプロジェクトの依存性を更新する方法を設定できます。 各エントリは、特定のパッケージマネージャーの更新設定を行います。 次のオプションを使用できます。
|
||||
|
||||
@@ -57,7 +57,7 @@ shortTitle: dependabot.ymlの設定
|
||||
|
||||
脆弱性のあるパッケージマニフェストのセキュリティアップデートは、デフォルトブランチでのみ発生します。 設定オプションが同じブランチに設定され（`target-branch` を使用しない場合は true）、脆弱性のあるマニフェストの `package-ecosystem` と `directory` を指定している場合、セキュリティアップデートのプルリクエストで関連オプションが使用されます。
|
||||
|
||||
一般に、セキュリティアップデートでは、メタデータの追加や動作の変更など、プルリクエストに影響する設定オプションが使用されます。 For more information about security updates, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)."
|
||||
一般に、セキュリティアップデートでは、メタデータの追加や動作の変更など、プルリクエストに影響する設定オプションが使用されます。 セキュリティアップデートに関する詳しい情報については、「[{% data variables.product.prodname_dependabot_security_updates %} を設定する](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)」を参照してください。
|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -292,7 +292,7 @@ updates:
|
||||
|
||||
リポジトリが`ignore`の設定を保存したかは、リポジトリで`"@dependabot ignore" in:comments`を検索すれば調べられます。 この方法で無視された依存関係の無視を解除したいなら、Pull Requestを再度オープンしてください。
|
||||
|
||||
For more information about the `@dependabot ignore` commands, see "[Managing pull requests for dependency updates](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)."
|
||||
`@dependabot ignore` コマンドに関する詳細については、「[依存関係の更新に関するPull Requestの管理](/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/managing-pull-requests-for-dependency-updates#managing-dependabot-pull-requests-with-comment-commands)」をご覧ください。
|
||||
|
||||
#### 無視する依存関係とバージョンを指定する
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ topics:
|
||||
- API
|
||||
---
|
||||
|
||||
GitHubのほとんどのオブジェクト（ユーザ、Issue、プルリクエストなど）には、REST APIを使っても、GraphQL APIを使ってもアクセスできます。 You can find the **global node ID** of many objects from within the REST API and use these IDs in your GraphQL operations. For more information, see "[Preview GraphQL API v4 Node IDs in REST API v3 resources](https://developer.github.com/changes/2017-12-19-graphql-node-id/)."
|
||||
GitHubのほとんどのオブジェクト（ユーザ、Issue、プルリクエストなど）には、REST APIを使っても、GraphQL APIを使ってもアクセスできます。 REST API内から多くのオブジェクトの**グローバルノードID**を見つけ、それらのIDをGraphQLの操作で利用できます。 詳しい情報については「[REST API v3リソース内のGraphQL API v4ノードIDのプレビュー](https://developer.github.com/changes/2017-12-19-graphql-node-id/)」を参照してください。
|
||||
|
||||
{% note %}
|
||||
|
||||
|
||||
@@ -76,7 +76,7 @@ Check Runs APIを使用するには、GitHub Appは`checks:write`権限が必要
|
||||
Checks APIで必要なアクションを設定する方法の詳しい例については、「[Checks APIでCIテストを作成する](/apps/quickstart-guides/creating-ci-tests-with-the-checks-api/#part-2-creating-the-octo-rubocop-ci-test)」を参照してください。
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
## Retention of checks data
|
||||
## チェックデータの保持
|
||||
|
||||
{% data reusables.pull_requests.retention-checks-data %}
|
||||
{% endif %}
|
||||
|
||||
@@ -77,3 +77,10 @@ upcoming_changes:
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: 破壊的
|
||||
owner: jdennes
|
||||
-
|
||||
location: RemovePullRequestFromMergeQueueInput.branch
|
||||
description: '`branch`は削除されます。'
|
||||
reason: PRs are removed from the merge queue for the base branch, the `branch` argument is now a no-op
|
||||
date: '2022-10-01T00:00:00+00:00'
|
||||
criticality: 破壊的
|
||||
owner: jhunschejones
|
||||
|
||||
@@ -98,6 +98,13 @@ upcoming_changes:
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: 破壊的
|
||||
owner: cheshire137
|
||||
-
|
||||
location: RemovePullRequestFromMergeQueueInput.branch
|
||||
description: '`branch`は削除されます。'
|
||||
reason: PRs are removed from the merge queue for the base branch, the `branch` argument is now a no-op
|
||||
date: '2022-10-01T00:00:00+00:00'
|
||||
criticality: 破壊的
|
||||
owner: jhunschejones
|
||||
-
|
||||
location: UpdateProjectNextItemFieldInput.fieldWithSettingId
|
||||
description: '`fieldWithSettingId`は削除されます。代わりに`fieldConstraintId`を使用してください'
|
||||
|
||||
@@ -98,6 +98,13 @@ upcoming_changes:
|
||||
date: '2022-07-01T00:00:00+00:00'
|
||||
criticality: 破壊的
|
||||
owner: cheshire137
|
||||
-
|
||||
location: RemovePullRequestFromMergeQueueInput.branch
|
||||
description: '`branch`は削除されます。'
|
||||
reason: PRs are removed from the merge queue for the base branch, the `branch` argument is now a no-op
|
||||
date: '2022-10-01T00:00:00+00:00'
|
||||
criticality: 破壊的
|
||||
owner: jhunschejones
|
||||
-
|
||||
location: UpdateProjectNextItemFieldInput.fieldWithSettingId
|
||||
description: '`fieldWithSettingId`は削除されます。代わりに`fieldConstraintId`を使用してください'
|
||||
|
||||
@@ -11,7 +11,7 @@ sections:
|
||||
changes:
|
||||
- '`ghe-cluster-suport-bundle`でクラスタSupport Bundleを作成する際の`gzip`圧縮の追加外部レイヤーは、デフォルトでオフになりました。この外部圧縮は、ghe-cluster-suport-bundle -c`コマンドラインオプションで適用できます。'
|
||||
- 体験を改善するためのモバイルアプリケーションのデータ収集についてユーザにリマインドするために、管理コンソールにテキストを追加しました。
|
||||
- The {% data variables.product.prodname_github_connect %} data connection record now includes a list of enabled {% data variables.product.prodname_github_connect %} features. [Updated 2021-12-09]
|
||||
- '{% data variables.product.prodname_github_connect %}データ接続レコードには、有効化された{% data variables.product.prodname_github_connect %}機能のリストが含まれるようになりました。[2021年12月09日更新]'
|
||||
known_issues:
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
|
||||
@@ -4,7 +4,7 @@ sections:
|
||||
security_fixes:
|
||||
- パッケージは最新のセキュリティバージョンにアップデートされました。
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -7,7 +7,7 @@ sections:
|
||||
- 高可用性レプリカのクロックがプライマリと同期していない場合、アップグレードが失敗することがありました。
|
||||
- '2020年9月1日以降に作成されたOAuthアプリケーションは、 [Check an Authorization](https://docs.github.com/en/enterprise-server@3.2/rest/reference/apps#check-an-authorization) API エンドポイントを使用できませんでした。'
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -35,7 +35,7 @@ sections:
|
||||
- The “Triage” and “Maintain” team roles are preserved during repository migrations.
|
||||
- Performance has been improved for web requests made by enterprise owners.
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -15,7 +15,7 @@ sections:
|
||||
- '{% data variables.product.prodname_codeql %}スターターワークフローは、{% data variables.product.prodname_actions %}のためのデフォルトのトークンの権限が使われていない場合でも、エラーになりません。'
|
||||
- If {% data variables.product.prodname_GH_advanced_security %} features are enabled on your instance, the performance of background jobs has improved when processing batches for repository contributions.
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -18,7 +18,7 @@ sections:
|
||||
- Support BundleにはMySQLに保存されたテーブルの行数が含まれるようになりました。
|
||||
- 依存関係グラフは脆弱性のデータなしで有効化できるようになり、使用されている依存関係とバージョンを見ることができるようになりました。{% data variables.product.prodname_github_connect %}を有効化せずに依存関係グラフを有効化しても、脆弱性の情報は提供され**ません**。
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -19,7 +19,7 @@ sections:
|
||||
changes:
|
||||
- '`ghe-cluster-suport-bundle`でクラスタSupport Bundleを作成する際の`gzip`圧縮の追加外部レイヤーは、デフォルトでオフになりました。この外部圧縮は、ghe-cluster-suport-bundle -c`コマンドラインオプションで適用できます。'
|
||||
- 体験を改善するためのモバイルアプリケーションのデータ収集についてユーザにリマインドするために、管理コンソールにテキストを追加しました。
|
||||
- The {% data variables.product.prodname_github_connect %} data connection record now includes a list of enabled {% data variables.product.prodname_github_connect %} features. [Updated 2021-12-09]
|
||||
- '{% data variables.product.prodname_github_connect %}データ接続レコードには、有効化された{% data variables.product.prodname_github_connect %}機能のリストが含まれるようになりました。[2021年12月09日更新]'
|
||||
known_issues:
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}で、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
|
||||
@@ -11,7 +11,7 @@ sections:
|
||||
changes:
|
||||
- Secret scaningがZIP及び他のアーカイブファイルでシークレットのスキャンをスキップしてしまいます。
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -6,7 +6,7 @@ sections:
|
||||
- '** 2021年12月17日更新 **: このリリースでの修正は、このリリース後に公開された[CVE-2021-45046](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-45046)も緩和します。CVE-2021-44228とCVE-2021-45046をどちらも緩和するために、{% data variables.product.prodname_ghe_server %}に追加のアップグレードは必要ありません。'
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -21,7 +21,7 @@ sections:
|
||||
- Several documentation links resulted in a 404 Not Found error.
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -19,7 +19,7 @@ sections:
|
||||
- GitHub Connectのデータ接続レコードに、アクティブ及び休眠ユーザ数と、設定された休眠期間が含まれるようになりました。
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -14,7 +14,7 @@ sections:
|
||||
- Secret scaningがZIP及び他のアーカイブファイルでシークレットのスキャンをスキップしてしまいます。
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -8,7 +8,7 @@ sections:
|
||||
- 'OAuth Applications created after September 1st, 2020 were not able to use the [Check an Authorization](https://docs.github.com/en/enterprise-server@3.3/rest/reference/apps#check-an-authorization) API endpoint.'
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -39,7 +39,7 @@ sections:
|
||||
- Performance has been improved for web requests made by enterprise owners.
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -21,7 +21,7 @@ sections:
|
||||
- If {% data variables.product.prodname_GH_advanced_security %} features are enabled on your instance, the performance of background jobs has improved when processing batches for repository contributions.
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -23,7 +23,7 @@ sections:
|
||||
- The `run_started_at` response field is now included in the [Workflow runs API](/rest/actions/workflow-runs) and the `workflow_run` event webhook payload.
|
||||
known_issues:
|
||||
- After upgrading to {% data variables.product.prodname_ghe_server %} 3.3, {% data variables.product.prodname_actions %} may fail to start automatically. To resolve this issue, connect to the appliance via SSH and run the `ghe-actions-start` command.
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
@@ -43,7 +43,7 @@ sections:
|
||||
- Users can now choose the number of spaces a tab is equal to, by setting their preferred tab size in the "Appearance" settings of their user account. All code with a tab indent will render using the preferred tab size.
|
||||
- The {% data variables.product.prodname_github_connect %} data connection record now includes a count of the number of active and dormant users and the configured dormancy period.
|
||||
-
|
||||
heading: Performance Changes
|
||||
heading: パフォーマンスの変更
|
||||
notes:
|
||||
- WireGuard, used to secure communication between {% data variables.product.prodname_ghe_server %} instances in a High Availability configuration, has been migrated to the Kernel implementation.
|
||||
-
|
||||
@@ -141,7 +141,7 @@ sections:
|
||||
#bugs:
|
||||
#- PLACEHOLDER
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
@@ -151,7 +151,7 @@ sections:
|
||||
- Actions services needs to be restarted after restoring appliance from backup taken on a different host.
|
||||
deprecations:
|
||||
-
|
||||
heading: Deprecation of GitHub Enterprise Server 3.0
|
||||
heading: GitHub Enterprise Server 3.0の非推奨化
|
||||
notes:
|
||||
- '**{% data variables.product.prodname_ghe_server %} 3.0 was discontinued on February 16, 2022**. This means that no patch releases will be made, even for critical security issues, after this date. For better performance, improved security, and new features, [upgrade to the newest version of {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.4/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.'
|
||||
-
|
||||
@@ -171,16 +171,16 @@ sections:
|
||||
notes:
|
||||
- 'The Codes of Conduct API preview, which was accessible with the `scarlet-witch-preview` header, is deprecated and no longer accessible in {% data variables.product.prodname_ghe_server %} 3.4. We instead recommend using the "[Get community profile metrics](/rest/reference/repos#get-community-profile-metrics)" endpoint to retrieve information about a repository''s code of conduct. For more information, see the "[Deprecation Notice: Codes of Conduct API preview](https://github.blog/changelog/2021-10-06-deprecation-notice-codes-of-conduct-api-preview/)" in the {% data variables.product.prodname_dotcom %} changelog.'
|
||||
-
|
||||
heading: Deprecation of OAuth Application API endpoints and API authentication using query parameters
|
||||
heading: OAuth Application APIエンドポイント及びクエリパラメータを使ったAPI認証の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting with {% data variables.product.prodname_ghe_server %} 3.4, the [deprecated version of the OAuth Application API endpoints](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/#endpoints-affected) have been removed. If you encounter 404 error messages on these endpoints, convert your code to the versions of the OAuth Application API that do not have `access_tokens` in the URL. We've also disabled the use of API authentication using query parameters. We instead recommend using [API authentication in the request header](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/#changes-to-make).
|
||||
-
|
||||
heading: Deprecation of the CodeQL runner
|
||||
heading: CodeQLランナーの非推奨化
|
||||
notes:
|
||||
- The {% data variables.product.prodname_codeql %} runner is deprecated in {% data variables.product.prodname_ghe_server %} 3.4 and is no longer supported. The deprecation only affects users who use {% data variables.product.prodname_codeql %} code scanning in third party CI/CD systems; {% data variables.product.prodname_actions %} users are not affected. We strongly recommend that customers migrate to the {% data variables.product.prodname_codeql %} CLI, which is a feature-complete replacement for the {% data variables.product.prodname_codeql %} runner. For more information, see the [{% data variables.product.prodname_dotcom %} changelog](https://github.blog/changelog/2021-09-21-codeql-runner-deprecation/).
|
||||
-
|
||||
heading: Deprecation of custom bit-cache extensions
|
||||
heading: カスタムのビットキャッシュ機能拡張の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting in {% data variables.product.prodname_ghe_server %} 3.1, support for {% data variables.product.company_short %}'s proprietary bit-cache extensions began to be phased out. These extensions are deprecated in {% data variables.product.prodname_ghe_server %} 3.3 onwards.
|
||||
|
||||
@@ -42,7 +42,7 @@ sections:
|
||||
- The {% data variables.product.prodname_github_connect %} data connection record now includes a count of the number of active and dormant users and the configured dormancy period.
|
||||
- You can now give users access to enterprise-specific links by adding custom footers to {% data variables.product.prodname_ghe_server %}. For more information, see "[Configuring custom footers](/admin/configuration/configuring-your-enterprise/configuring-custom-footers)."
|
||||
-
|
||||
heading: Performance Changes
|
||||
heading: パフォーマンスの変更
|
||||
notes:
|
||||
- WireGuard, used to secure communication between {% data variables.product.prodname_ghe_server %} instances in a High Availability configuration, has been migrated to the Kernel implementation.
|
||||
-
|
||||
@@ -144,7 +144,7 @@ sections:
|
||||
#bugs:
|
||||
#- PLACEHOLDER
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
@@ -160,7 +160,7 @@ sections:
|
||||
- Copy the SAML metadata, remove `WantAssertionsEncrypted` attribute, host it on a web server, and reconfigure the IdP to point to that URL.
|
||||
deprecations:
|
||||
-
|
||||
heading: Deprecation of GitHub Enterprise Server 3.0
|
||||
heading: GitHub Enterprise Server 3.0の非推奨化
|
||||
notes:
|
||||
- '**{% data variables.product.prodname_ghe_server %} 3.0 was discontinued on February 16, 2022**. This means that no patch releases will be made, even for critical security issues, after this date. For better performance, improved security, and new features, [upgrade to the newest version of {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.4/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.'
|
||||
-
|
||||
@@ -180,16 +180,16 @@ sections:
|
||||
notes:
|
||||
- 'The Codes of Conduct API preview, which was accessible with the `scarlet-witch-preview` header, is deprecated and no longer accessible in {% data variables.product.prodname_ghe_server %} 3.4. We instead recommend using the "[Get community profile metrics](/rest/reference/repos#get-community-profile-metrics)" endpoint to retrieve information about a repository''s code of conduct. For more information, see the "[Deprecation Notice: Codes of Conduct API preview](https://github.blog/changelog/2021-10-06-deprecation-notice-codes-of-conduct-api-preview/)" in the {% data variables.product.prodname_dotcom %} changelog.'
|
||||
-
|
||||
heading: Deprecation of OAuth Application API endpoints and API authentication using query parameters
|
||||
heading: OAuth Application APIエンドポイント及びクエリパラメータを使ったAPI認証の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting with {% data variables.product.prodname_ghe_server %} 3.4, the [deprecated version of the OAuth Application API endpoints](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/#endpoints-affected) have been removed. If you encounter 404 error messages on these endpoints, convert your code to the versions of the OAuth Application API that do not have `access_tokens` in the URL. We've also disabled the use of API authentication using query parameters. We instead recommend using [API authentication in the request header](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/#changes-to-make).
|
||||
-
|
||||
heading: Deprecation of the CodeQL runner
|
||||
heading: CodeQLランナーの非推奨化
|
||||
notes:
|
||||
- The {% data variables.product.prodname_codeql %} runner is deprecated in {% data variables.product.prodname_ghe_server %} 3.4 and is no longer supported. The deprecation only affects users who use {% data variables.product.prodname_codeql %} code scanning in third party CI/CD systems; {% data variables.product.prodname_actions %} users are not affected. We strongly recommend that customers migrate to the {% data variables.product.prodname_codeql %} CLI, which is a feature-complete replacement for the {% data variables.product.prodname_codeql %} runner. For more information, see the [{% data variables.product.prodname_dotcom %} changelog](https://github.blog/changelog/2021-09-21-codeql-runner-deprecation/).
|
||||
-
|
||||
heading: Deprecation of custom bit-cache extensions
|
||||
heading: カスタムのビットキャッシュ機能拡張の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting in {% data variables.product.prodname_ghe_server %} 3.1, support for {% data variables.product.company_short %}'s proprietary bit-cache extensions began to be phased out. These extensions are deprecated in {% data variables.product.prodname_ghe_server %} 3.3 onwards.
|
||||
|
||||
@@ -40,7 +40,7 @@ sections:
|
||||
- Using ghe-migrator or exporting from GitHub.com, an export would not include Pull Request attachments.
|
||||
- Performance has been improved for web requests made by enterprise owners.
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
@@ -55,7 +55,7 @@ sections:
|
||||
- Copy the SAML metadata, remove `WantAssertionsEncrypted` attribute, host it on a web server, and reconfigure the IdP to point to that URL.
|
||||
deprecations:
|
||||
-
|
||||
heading: Deprecation of GitHub Enterprise Server 3.0
|
||||
heading: GitHub Enterprise Server 3.0の非推奨化
|
||||
notes:
|
||||
- '**{% data variables.product.prodname_ghe_server %} 3.0 was discontinued on February 16, 2022**. This means that no patch releases will be made, even for critical security issues, after this date. For better performance, improved security, and new features, [upgrade to the newest version of {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.4/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.'
|
||||
-
|
||||
@@ -75,16 +75,16 @@ sections:
|
||||
notes:
|
||||
- 'The Codes of Conduct API preview, which was accessible with the `scarlet-witch-preview` header, is deprecated and no longer accessible in {% data variables.product.prodname_ghe_server %} 3.4. We instead recommend using the "[Get community profile metrics](/rest/reference/repos#get-community-profile-metrics)" endpoint to retrieve information about a repository''s code of conduct. For more information, see the "[Deprecation Notice: Codes of Conduct API preview](https://github.blog/changelog/2021-10-06-deprecation-notice-codes-of-conduct-api-preview/)" in the {% data variables.product.prodname_dotcom %} changelog.'
|
||||
-
|
||||
heading: Deprecation of OAuth Application API endpoints and API authentication using query parameters
|
||||
heading: OAuth Application APIエンドポイント及びクエリパラメータを使ったAPI認証の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting with {% data variables.product.prodname_ghe_server %} 3.4, the [deprecated version of the OAuth Application API endpoints](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/#endpoints-affected) have been removed. If you encounter 404 error messages on these endpoints, convert your code to the versions of the OAuth Application API that do not have `access_tokens` in the URL. We've also disabled the use of API authentication using query parameters. We instead recommend using [API authentication in the request header](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/#changes-to-make).
|
||||
-
|
||||
heading: Deprecation of the CodeQL runner
|
||||
heading: CodeQLランナーの非推奨化
|
||||
notes:
|
||||
- The {% data variables.product.prodname_codeql %} runner is deprecated in {% data variables.product.prodname_ghe_server %} 3.4 and is no longer supported. The deprecation only affects users who use {% data variables.product.prodname_codeql %} code scanning in third party CI/CD systems; {% data variables.product.prodname_actions %} users are not affected. We strongly recommend that customers migrate to the {% data variables.product.prodname_codeql %} CLI, which is a feature-complete replacement for the {% data variables.product.prodname_codeql %} runner. For more information, see the [{% data variables.product.prodname_dotcom %} changelog](https://github.blog/changelog/2021-09-21-codeql-runner-deprecation/).
|
||||
-
|
||||
heading: Deprecation of custom bit-cache extensions
|
||||
heading: カスタムのビットキャッシュ機能拡張の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting in {% data variables.product.prodname_ghe_server %} 3.1, support for {% data variables.product.company_short %}'s proprietary bit-cache extensions began to be phased out. These extensions are deprecated in {% data variables.product.prodname_ghe_server %} 3.3 onwards.
|
||||
|
||||
@@ -19,7 +19,7 @@ sections:
|
||||
- Configuration errors that halt a config apply run are now output to the terminal in addition to the configuration log.
|
||||
- If {% data variables.product.prodname_GH_advanced_security %} features are enabled on your instance, the performance of background jobs has improved when processing batches for repository contributions.
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
@@ -34,7 +34,7 @@ sections:
|
||||
- Copy the SAML metadata, remove `WantAssertionsEncrypted` attribute, host it on a web server, and reconfigure the IdP to point to that URL.
|
||||
deprecations:
|
||||
-
|
||||
heading: Deprecation of GitHub Enterprise Server 3.0
|
||||
heading: GitHub Enterprise Server 3.0の非推奨化
|
||||
notes:
|
||||
- '**{% data variables.product.prodname_ghe_server %} 3.0 was discontinued on February 16, 2022**. This means that no patch releases will be made, even for critical security issues, after this date. For better performance, improved security, and new features, [upgrade to the newest version of {% data variables.product.prodname_ghe_server %}](/enterprise-server@3.4/admin/enterprise-management/upgrading-github-enterprise-server) as soon as possible.'
|
||||
-
|
||||
@@ -54,16 +54,16 @@ sections:
|
||||
notes:
|
||||
- 'The Codes of Conduct API preview, which was accessible with the `scarlet-witch-preview` header, is deprecated and no longer accessible in {% data variables.product.prodname_ghe_server %} 3.4. We instead recommend using the "[Get community profile metrics](/rest/reference/repos#get-community-profile-metrics)" endpoint to retrieve information about a repository''s code of conduct. For more information, see the "[Deprecation Notice: Codes of Conduct API preview](https://github.blog/changelog/2021-10-06-deprecation-notice-codes-of-conduct-api-preview/)" in the {% data variables.product.prodname_dotcom %} changelog.'
|
||||
-
|
||||
heading: Deprecation of OAuth Application API endpoints and API authentication using query parameters
|
||||
heading: OAuth Application APIエンドポイント及びクエリパラメータを使ったAPI認証の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting with {% data variables.product.prodname_ghe_server %} 3.4, the [deprecated version of the OAuth Application API endpoints](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/#endpoints-affected) have been removed. If you encounter 404 error messages on these endpoints, convert your code to the versions of the OAuth Application API that do not have `access_tokens` in the URL. We've also disabled the use of API authentication using query parameters. We instead recommend using [API authentication in the request header](https://developer.github.com/changes/2020-02-10-deprecating-auth-through-query-param/#changes-to-make).
|
||||
-
|
||||
heading: Deprecation of the CodeQL runner
|
||||
heading: CodeQLランナーの非推奨化
|
||||
notes:
|
||||
- The {% data variables.product.prodname_codeql %} runner is deprecated in {% data variables.product.prodname_ghe_server %} 3.4 and is no longer supported. The deprecation only affects users who use {% data variables.product.prodname_codeql %} code scanning in third party CI/CD systems; {% data variables.product.prodname_actions %} users are not affected. We strongly recommend that customers migrate to the {% data variables.product.prodname_codeql %} CLI, which is a feature-complete replacement for the {% data variables.product.prodname_codeql %} runner. For more information, see the [{% data variables.product.prodname_dotcom %} changelog](https://github.blog/changelog/2021-09-21-codeql-runner-deprecation/).
|
||||
-
|
||||
heading: Deprecation of custom bit-cache extensions
|
||||
heading: カスタムのビットキャッシュ機能拡張の非推奨化
|
||||
notes:
|
||||
- |
|
||||
Starting in {% data variables.product.prodname_ghe_server %} 3.1, support for {% data variables.product.company_short %}'s proprietary bit-cache extensions began to be phased out. These extensions are deprecated in {% data variables.product.prodname_ghe_server %} 3.3 onwards.
|
||||
|
||||
@@ -26,7 +26,7 @@ sections:
|
||||
- When determining which repository networks to schedule maintenance on, we no longer count the size of unreachable objects.
|
||||
- The `run_started_at` response field is now included in the [Workflow runs API](/rest/actions/workflow-runs) and the `workflow_run` event webhook payload.
|
||||
known_issues:
|
||||
- On a freshly set up {% data variables.product.prodname_ghe_server %} instance without any users, an attacker could create the first admin user.
|
||||
- 新しくセットアップされたユーザを持たない{% data variables.product.prodname_ghe_server %}インスタンスで、攻撃者が最初の管理ユーザを作成できました。
|
||||
- アップグレードの過程で、カスタムのファイアウォールのルールが削除されます。
|
||||
- Git LFSが追跡するファイル[Webインターフェースからアップロードされたもの](https://github.com/blog/2105-upload-files-to-your-repositories)が、不正にリポジトリに直接追加されてしまいます。
|
||||
- 同じリポジトリ内のファイルパスが255文字を超えるblobへのパーマリンクを含むIssueをクローズできませんでした。
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user